Branches

Rules of the branches

The development process should follow these rules:

1. The dev branch is the first branch, where all PRs should go. Anybody can make a PR to this branch. All PRs and merges from this branch are going to be done to the main branch only.
2. The main branch should contain stable code only. Any small changes should happen in the dev branch. Only repository admins can make PRs and merges to this branch. All PRs and merges from this branch are going to be done to the prod branch only.
3. The prod branch should contain only stable and well-tested code since code from this branch is going to be deployed to the real server. No PRs or merges are allowed from this branch.
4. All repository collaborators are responsible for the stability of the dev branch and should check that their own changes are not breaking the existing code, at least in their own branches from which PRs to the dev branch are coming.
5. The repository admin is responsible for reviewing all PRs coming to the dev branch. The admin is also responsible for syncing the dev, main, and prod branches and verifying their stability.

Branches naming

Branches are usually created one for one issue and because of that they usually should not be in use for a long time and removed after PR to the dev branch was accepted and merged.

Contributors should follow these conventions in branch naming:

1. At the first place of branch goes an issue type with "/" in the end
2. After that some short free form descriptive name, kebab-case
3. In the end there should be a number of the issue to which branch is connected to

Possible branches/issues types:

1. feature - new feature to be added (all issues with feature label)
2. change - change of existing functionality (all issues with change label)
3. bug - fixing some bug (all issues with bug label)
4. docs - updating some docs (JSDocs, line comments, swagger etc.) (all issues with docs label)

Examples:

• feature/authorization-clan-45 new feature for adding authorization rules, associated issue number 45
• docs/swagger-stock-20 add documentation for /stock endpoint, associated issue number 20