Skip to content

Commit

Permalink
Merge pull request #546 from coldav/colin/contributor_pull_request
Browse files Browse the repository at this point in the history
Updated CONTRIBUTING guide to explain pull request protocol
  • Loading branch information
coldav authored Oct 8, 2024
2 parents c46f28e + 16c0375 commit 5df3663
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,10 +249,21 @@ steps.
proposing and why.
* Provide a general overview of how the code contribution works, detailing the
effects and consequences of the change.
* Address feedback from participants and resolve any test failures.
* Wait for CI to be approved and resolve any test failures.
* Address feedback from reviewers.
* Wait for a project maintainer to make an approving review.
* Wait for your pull request to be merged.

For CI you will need to wait for someone from @ock-reviewers to enable the CI
(or @ock-workflow-reviewers if it is workflow related). The CI can then be
approved based on the PR. Note that currently some of the CI PR testing is done
outside of github and you will be notified of any related failures. This is
currently being addressed. Once it has been approved you can ping @ock-reviewers
to merge it.

It is also possible that after merging to the main branch an overnight failure
may show up issues and a comment will be added to the merged PR.

As a final note, try to keep your pull request branch in good condition. If you
think it makes sense to split your changes across multiple commits, or later
squash multiple commits into one larger commit, please do so. In all
Expand Down

0 comments on commit 5df3663

Please sign in to comment.