Added backquotes around the branch names.

This commit is contained in:
MohitMaliFtechiz 2024-01-05 20:06:53 +05:30
parent 4da3922a18
commit be0961cda5

View File

@ -45,8 +45,8 @@ Our process for accepting changes operates by [Pull Request (PR)](https://help.g
Our branching strategy is based on [this article](https://nvie.com/posts/a-successful-git-branching-model/) which we suggest you read. Our branching strategy is based on [this article](https://nvie.com/posts/a-successful-git-branching-model/) which we suggest you read.
+ **main** the actively worked on next release of the app, what we branch off of while working on new features and what we merge into upon feature completion + **main** the actively worked on next release of the app, what we branch off of while working on new features and what we merge into upon feature completion
+ **feature/** or feature/\<username\>/ any branch under this directory is an actively developed feature, feature branches culminate in a PR, are merged and deleted. + **feature/** or feature/\<username\>/ any branch under this directory is an actively developed feature, `feature` branches culminate in a PR, are merged and deleted.
Typically a feature branch is off of main and into develop but in rare scenarios if there is an issue in production a branch may be made off main to fix this issue, this type of feature branch must be merged to main before being deleted. Typically a `feature` branch is off of `main` and into develop but in rare scenarios, if there is an issue in production a branch may be made off `main` to fix this issue, this type of `feature` branch must be merged to `main` before being deleted.
Branch names should be in the format **\<issue-number\>-kebab-case-title** Branch names should be in the format **\<issue-number\>-kebab-case-title**
All branches should have distinct history and should be visually easy to follow, for this reason only perform merge commits when merging code either by PR or when synchronising. All branches should have distinct history and should be visually easy to follow, for this reason only perform merge commits when merging code either by PR or when synchronising.