Skip to content

Repository management rules

dev.inch edited this page Oct 7, 2024 · 7 revisions

The branch system in the repository:

  • main - a branch that exclusively hosts versions intended for public release. Changes to this branch are made exclusively after the code review as part of the team.
  • develop - a branch that hosts current but verified changes. The develop branch should accept only COMPLETED and PROVEN functionality.

When implementing new functionality, correcting, refactoring, and performing operations with code from the develop branch, you must switch to the develop branch using git switch develop and perform the appropriate branch using the git switch -c <branch-name> command. The name of the new branch should look like label/name.

List of available labels and corresponding names:

  • feature/<feature-name> - a branch type designed to implement new functions in the project. For example feature/haptic-feedback or feature/daily-rewards.
  • fix/<short-bug-name> - a branch type designed to fix errors in the repository. For example fix/timer-error or fix/create-user.
  • refactoring/<place-name> - a branch engine designed for refactoring and code cleanup. The branch name must contain the directory (part) of the application that is being refactored. For example refactoring/home-page or refactoring/*.scss.
  • upgrade/<feature-name> - a branch type designed to improve existing functionality (namely, improvement, not refactoring). For example upgrade/localization or upgrade/tasks.
  • style/<feature-name> - a branch type designed to change the visual component (UI). For example style/profile or style/haeder.
  • chore/<event-name> - a branch type intended for making changes unrelated to the main code base of the repository. For example chore/documentation or chore/add-comments.

Clone this wiki locally