docs: establish PicadoLabs open-source governance, CI workflows, and contributor guidelines
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Create a report to help us improve Model Router
|
||||
title: "[BUG] "
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
## Environment
|
||||
- OS: [e.g. Ubuntu 22.04, macOS 14.2, Windows 11]
|
||||
- Python Version: [e.g. 3.11.8]
|
||||
- Node.js Version: [e.g. 20.11.0]
|
||||
- Router Mode: [e.g. rules, llm]
|
||||
- Provider: [e.g. mock, ollama, openai]
|
||||
|
||||
## Steps to Reproduce
|
||||
1. Start server with `...`
|
||||
2. Send request to `...`
|
||||
3. See error
|
||||
|
||||
## Expected Behavior
|
||||
A clear description of what you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
A clear description of what actually happened.
|
||||
|
||||
## Logs / Screenshots
|
||||
If applicable, add console output or screenshots to help explain your problem.
|
||||
|
||||
## Additional Context
|
||||
Add any other context about the problem here.
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest an idea or capability for Model Router
|
||||
title: "[FEATURE] "
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Problem / Use Case
|
||||
Is your feature request related to a problem or specific use case? Please describe.
|
||||
|
||||
## Proposed Solution
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
## Alternatives Considered
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
## Additional Context
|
||||
Add any other context or screenshots about the feature request here.
|
||||
@@ -0,0 +1,24 @@
|
||||
## Summary
|
||||
Provide a brief summary of the changes introduced in this pull request.
|
||||
|
||||
## Motivation
|
||||
Explain why this change is necessary and what issue it resolves.
|
||||
|
||||
## Changes Made
|
||||
- List key changes and additions.
|
||||
- Reference modified files and modules.
|
||||
|
||||
## Testing Performed
|
||||
- [ ] Backend tests passing (`pytest backend/tests`)
|
||||
- [ ] Frontend build passing (`cd frontend && npm run build`)
|
||||
- [ ] Manual verification in Control Room or Typer CLI
|
||||
|
||||
## Breaking Changes
|
||||
- [ ] Yes (explain below)
|
||||
- [ ] No
|
||||
|
||||
## Checklist
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have added tests that prove my fix or feature works
|
||||
- [ ] I have updated the documentation accordingly
|
||||
@@ -0,0 +1,57 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
|
||||
jobs:
|
||||
backend-test:
|
||||
name: Backend Tests (Python ${{ matrix.python-version }})
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.10", "3.11", "3.12"]
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
cache: 'pip'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
|
||||
- name: Run Pytest suite
|
||||
run: |
|
||||
pytest backend/tests -v
|
||||
|
||||
frontend-build:
|
||||
name: Frontend Build & Typecheck
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node.js 20
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: 'npm'
|
||||
cache-dependency-path: frontend/package.json
|
||||
|
||||
- name: Install frontend dependencies
|
||||
working-directory: frontend
|
||||
run: npm ci
|
||||
|
||||
- name: Build and typecheck frontend
|
||||
working-directory: frontend
|
||||
run: npm run build
|
||||
Reference in New Issue
Block a user