Skip to content

Commit

Permalink
[#506] Adjustment the contributing guidelines to reflect recent changes
Browse files Browse the repository at this point in the history
The changes made include updating the CONTRIBUTING.md document to
include moving the ticket to the 'in review' status when the PR is ready
for review, changing the state of the PR from draft to actual PR,
addressing all change requests before merging the branch into `develop`,
and automating the deployment process to the test and staging
environments. These modifications aim to streamline the development
workflow by ensuring that tickets, PRs, and branches are managed
efficiently during the development and review phases.
  • Loading branch information
placek committed Mar 21, 2024
1 parent 68df326 commit 862068e
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ Try to keep branches up-to-date with main (not strict requirement though).
Once merged to main, please delete the branch.

**Tip:** Use Github's merge button in PRs to merge with commit.
This strategy helps us operate on the commits you've delivered: it's easier to [cherry-pick a merge commit](https://git-scm.com/docs/git-cherry-pick#Documentation/git-cherry-pick.txt--mltparent-numbergt) than a series of commits, and it's also easier to [revert changes using a merge commit](https://git-scm.com/docs/git-revert#Documentation/git-revert.txt--mparent-number) instead of a series of reverts.
If a branch is outdated, use the rebase button in PRs to rebase feature branches (NOT update via merge).

#### Rationale
Expand Down Expand Up @@ -229,19 +230,21 @@ TODO
- Choose ticket/issue to work on from the project, move ticket from `todo` to `in progress`.
- Create [well named](#branch-naming) branch from `develop` add changes, then make a pull request back to the `develop` branch.
- If the changes are not ready for review then feel free to create a draft PR, and link this to the ticket/issue.
- When the PR is ready for review move the ticket from `in progress` to `in review`. Remember to change the state of the PR from draft to actual PR.
- Developers should review each other's pull requests, and should be requested via [CODEOWNERS](./CODEOWNERS).
- Unit tests are run on each pull request to `develop`.
- Once tests pass and peer review is done the branch can be merged into `develop` by author and then deployed to the dev environment (manually for now).
- The ticket status can then be moved ticket to `in QA` making sure that the PR/branch has been added to the ticket/issue as a comment.
- After a review remember to address all the requests of changes since they are blocking PR from being merged.
- Once tests pass and peer review is done the branch can be merged into `develop` by author and then deployed to the dev environment (manually).
- The ticket status can then be moved to `in QA` making sure that the PR/branch has been added to the ticket/issue as a comment.

### QA Workflow

- Choose ticket from `in QA`.
- Merge in the ticket's changes from `develop` branch into `test` branch.
- Deploy to test environment (manually for now).
- Deploy to test environment (automatically).
- The QA tests the deployed test environment against the ticket.
- If QA agrees that the code is good, they can make a PR from `test` branch to `staging` branch where end-to-end and performance tests are run.
- If tests pass, then QA or tech lead can merge and deploy to staging environment (manually for now).
- If tests pass, then QA or tech lead can merge and deploy to staging environment (automatically).
- Moving ticket to `staging` status this ready for PO check.

### PO Workflow
Expand Down

0 comments on commit 862068e

Please sign in to comment.