Welcome to the team guidelines. This documentation centralizes best practices for approaching the collective project with confidence.
| # | Topic | Description |
|---|---|---|
| 1 | Nomenclature | File and folder naming and structure conventions |
| 2 | Branching Strategy | Git workflow, branch types and merge strategy |
| 3 | GitHub: Issues & Pull Requests | Creating issues, lifecycle, opening and reviewing PRs |
| 4 | Code Retrieval (Safety) | Pull, rebase, merge, conflict handling and best practices |
| 5 | Commit Messages | Naming convention and commit structure |
| 6 | Code Review | Best practices for reviewing and being reviewed |
- New to the project? → Start with Nomenclature and Branching Strategy
- Working on a feature? → Check GitHub Workflow and Commit Messages
- Pulling or merging code? → Read Git Safety
- Doing a code review? → Refer to Code Review
These guidelines are living documents. Propose improvements via an Issue or Pull Request — we iterate together.