From 87862b64b8f540da023a9dfebfd6186b36b5715d Mon Sep 17 00:00:00 2001 From: bruno Date: Wed, 8 Jul 2026 09:02:02 -0400 Subject: [PATCH] docs: CONTRIBUTING.md + CI pipeline Gitea Actions --- .gitea/workflows/ci.yml | 24 ++++++++++++++++++++++++ CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 .gitea/workflows/ci.yml create mode 100644 CONTRIBUTING.md diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml new file mode 100644 index 0000000..87387f1 --- /dev/null +++ b/.gitea/workflows/ci.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..71860ae --- /dev/null +++ b/CONTRIBUTING.md @@ -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).