2. Branching
This document outlines the branching strategy and naming conventions to maintain consistency and clarity in our development process.
Use the following prefixes to categorize your branches:
-
feature: New features -
bug: Bug fixes -
hotfix: Urgent, critical fixes -
enhancement: Improvements to existing features -
refactor: Code refactoring -
docs: Documentation updates -
test: Adding or updating tests -
chore: Non-functional tasks (e.g., dependency updates) -
perf: Performance improvements -
style: Code style changes (e.g., formatting, whitespace)
Branch names should follow this structure for better traceability:
<username>/<prefix>/<issue-number and short-description>
joni/feature/1-add-authenticationpeter/bug/12-fix-login-issueparker/hotfix/123-resolve-database-error
dev branch to ensure they are based on the latest development code.
-
Go to the Issues page in GitHub and locate the issue you're working on.
-
Assign the issue to yourself to prevent overlapping work.
-
Create the branch using the link on the right. Follow the naming convention and ensure you set the branch source to
dev.
-
After creating the branch, add it to the project board under the "In Progress" column to keep your tasks organized.
-
Verify that your new branch is visible in VS Code under Source Control. Alternatively, you can pull the branch using other GitHub tools like GitHub Desktop.
- Keep it focused: Avoid including multiple unrelated tasks in a single branch to maintain a clean and organized codebase.
- Be descriptive: Use clear and concise descriptions in your branch names to make them easily identifiable.
- Commit Regularly and Push Often: Please don't keep commits only locally; push them regularly so we can track the project's progress and ensure you have a remote backup of your code —at least at the end of each workday.