This repository has been archived by the owner on Feb 25, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 40
Sheriff and merge process
mwobensmith edited this page Dec 18, 2018
·
3 revisions
Once code has been approved by a reviewer, the sheriff on duty can perform a merge into the dev
branch. No branches will be approved for merge into dev
without the sheriff's approval.
- Developer submits work for review via a pull request into
dev
. - When code is approved, reviewer will indicate such in the PR.
- The sheriff will make an inspection:
- Is the branch properly named for the current issue?
- If a PR has been made, does the commit message look correct?
- Are there any obvious issues with code quality or the commit in general?
- If there are problems, it gets sent back to developer and/or reviewer for correction.
- If it looks satisfactory, the sheriff will attempt a rebase merge.
- If the code will not merge correctly, the code goes back to the developer for a rebase.
- Once the developer has rebased, any of the parties above can attempt another PR against
dev
. - When GitHub indicates that the code can be successfully merged, the sheriff can continue.
- In the comments for the PR, the sheriff will enter "fixes" or "closes" plus the number of the issue it's addressing, e.g. "Fixes #1009".
- The sheriff submits the PR to perform the merge.
- The branch is not deleted, and the GitHub issue remains open. That will be taken care of during the merge process.
- On Fridays, all final check-ins are completed.
- Runs of Iris are performed to make sure Iris is stable.
- A pull request is created from
dev
tomaster
. - In a comment on the PR, the text "Fixes" or "Closes" is used plus the issue(s) included, e.g.:
Fixes #1001
Fixes #1003
Fixes #1004
- The PR is submitted as a rebase.
- If there are any conflicts, these are fixed either using GitHub's web interface, or locally via PyCharm's visual conflict editor.
- Once all conflicts are corrected, the rebase is attempted again.
- When the PR has successfully been completed, all included branches corresponding to the week's fixed bugs are deleted.
Note: There is no need to close the corresponding issues, as the comment in step 4 above does this automatically.
Installation
Running Iris
- Basic workflow
- Useful examples
- Using the Control Center
- Runtime argument list
- How to run update tests
Contributing to Iris
- Contributors
- Creating a test case
- Developer requirements
- Creating images
- Iris APIs - coming soon
- Code style guide
Iris Team Workflow
- Getting code into Iris
- Communicating with the team
- Sheriff and merge process
- Monitoring daily test runs
Release QA Team Workflow