docs: CONTRIBUTING.md + CI pipeline Gitea Actions
This commit is contained in:
@@ -0,0 +1,24 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: python:3.12-slim
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: pip install -r requirements.txt pytest
|
||||||
|
- run: python -m pytest tests/ -v
|
||||||
|
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: python:3.12-slim
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: pip install ruff
|
||||||
|
- run: ruff check app/ --ignore F401,F841
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# Contribuer à FlowDeck
|
||||||
|
|
||||||
|
## Développement
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 -m venv venv && source venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
cp .env.example .env # éditer
|
||||||
|
uvicorn app.main:app --reload --port 8082
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install pytest
|
||||||
|
python -m pytest tests/ -v
|
||||||
|
```
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- **Commits** : [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:`, `refactor:`, `test:`)
|
||||||
|
- **Code** : ruff + black, type hints partout
|
||||||
|
- **Branche** : `feature/xxx` → PR → `main`
|
||||||
|
- **Langue** : code + commentaires en anglais, docs en français
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
Voir [ARCHITECTURE.md](ARCHITECTURE.md).
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
Voir [ROADMAP.md](ROADMAP.md).
|
||||||
Reference in New Issue
Block a user