-
Notifications
You must be signed in to change notification settings - Fork 131
Development Processes
Dragan Ivanovic edited this page Feb 22, 2024
·
13 revisions
Development contributions and collaboration take place primarily in this repository on GitHub and in GitHub issues. When changes for revision (pull requests) are submitted, they must adhere to the following criteria:
- There should be a GitHub issue that explains the reason for the change and serves as a platform for issue-level discussion. Discussion regarding code details should take place directly on a pull request in the comments or as line notes.
- The changes must be made in a branch and submitted as a pull request.
- The submitted pull request must reference the associated GitHub issue.
- Large pull requests should be avoided. However, if it is absolutely necessary, a short description why it is not possible to decouple/modularize the pull request in a couple of smaller pull requests is expected in the pull request description.
- A pull request description should include steps for testing.
- A pull request may be merged when 2 or more committers (excluding the author) have responded with +1, and after 2 months have passed with no committers having responded with -1 nor "More Time Needed".
- As an exception to the above, pull requests that are labelled in GitHub with
small PRcan be fast-tracked, allowing merge with only one (committer) review. - No pull request into the main branch may ever be merged by the author of the pull request or any person affiliated with the same entity as the author.
After a pull-request has been reviewed and is ready to be committed to the code base
- Squash-merge in GitHub
- Ensure that merge commit comment does not include trivial notes (e.g. Removed whitespace)
- Ensure that merge commit contains link to GitHub ticket (e.g. Resolves:
link-to-GitHub-issue)
- Ensure that link to GitHub pull request is referenced in GitHub issue comment
- Close GitHub issue