Welcome! This cheat sheet summarizes the most important standards and conventions for contributing to this project. For full details, see the Standards & Conventions.
| Task | Command/Convention | Example/Notes |
|---|---|---|
| Branch Naming | launch_{number}_task_{number} |
launch_1_task_1 |
| Commit Message | Conventional Commits | feat: add user login |
| Run Tests | make test |
Uses pytest |
| Format Code | make format |
Run before commit |
| Lint Code | make lint |
Run before commit |
| Type Check | make type-check |
|
| Security Check | make secure |
- Pattern:
launch_{number}_task_{number} - Example:
launch_1_task_1
- Use Conventional Commits
- Example:
feat: add user login
- Name PRs using Conventional Commits format
- In PR description, include task closure keyword (e.g.,
Closes #1) - See: Linking a pull request to an issue
- Write and pass unit tests (
make test) - Use pytest as the test library
- Ensure code is formatted and linted before committing
make test— Run unit testsmake format— Format codemake lint— Lint codemake secure— Security checkmake type-check— Type check
For comprehensive standards and conventions, see Standards & Conventions.