Skip to content

Commit

Permalink
Switch issue # and description in naming convention
Browse files Browse the repository at this point in the history
This is more in line with Github's default naming
  • Loading branch information
CyrusVorwald authored Jul 27, 2022
1 parent e3dc759 commit 43e165a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Issues that are not currently being worked on but determined to be part of this

Issues currently being worked on should be in the "In Progress" column, assigned this week's sprint, and assigned a time estimate (# of days to complete the issue). It's ok if the time estimate is not accurate, as it is only an estimate.

Issues currently being worked on should each have an associated branch. If an issue needs multiple branches, the issue is probably too large and should be broken down into multiple smaller issues. If the issue is describing a feature, the naming convention of the branch should be "feature/[description]-[issue #]". If the issue is describing a bug fix, the naming convention of the branch should be "fix/[description]-[issue #]".
Issues currently being worked on should each have an associated branch. If an issue needs multiple branches, the issue is probably too large and should be broken down into multiple smaller issues. If the issue is describing a feature, the naming convention of the branch should be "feature/[issue #]-[description]". If the issue is describing a bug fix, the naming convention of the branch should be "fix/[issue #]-[description]".

After the developer working on the branch determines the feature (or fix) branch satisfies the acceptance criteria of the associated issue and has sufficiently tested the added code, the developer should submit a pull request with at least 1 reviewer assigned for the feature branch to be merged into the main branch. When the branch is submitted for pull request, the associated issue should go into the "Review / QA" column in Zenhub.

Expand Down

0 comments on commit 43e165a

Please sign in to comment.