contributing:core_committer_process
This is an old revision of the document!
Core Committer Process
These instructions are meant as an introductory, step-by-step guide for new Core Committers.
- Choose a Launchpad Ticket
- Ideally, choose a ticket that has the pullrequest and signedoff tags.
- If it only has the pullrequest tag, you will be responsible for the testing and signoff stage as well as the committing stage.
- Review, Install, Test
- Review the Code
- Code formatting - whitespace, etc.?
- Consistency with other code?
- Good variable names, clear comments?
- Logically well-constructed?
- Descriptive commit messages?
- Release notes?
- Documentation?
- Does it need to be rebased to current main? You may do this yourself or ask the original submitter to do so (add the “needsrebase” tag if so).
- Are there multiple commits? Some patches may be intentionally split into multiple logical commits, but other patches may just have minor changes and corrections in multiple commits that can be squashed for clarity. Creating a local branch to handle the squashing can be useful, or you may wish to refer it back to the original submitter (add the "needswork" tag if so).
- Install the Code
- This will vary depending upon your development environment.
- Test the Code
- Your level of testing will vary depending on code complexity and how well you understand what it is doing.
- Does it work in the UI?
- Are there database changes? If so, is there an upgrade script that matches the database changes?
- Are there Perl/PostgreSQL/NPM-level tests to run?
- Are there any error messages generated in the server logs?
- Begin the Merge
- git checkout main
- git pull origin main
- git remote update
- git cherry-pick -s [branch id]
- For multiple commits on a branch: git cherry-pick -s [oldest hash]^..[newest hash]
- git commit –amend
- Add signoffs as needed (review Launchpad ticket)
- Amend title if needed (make sure it includes LP number)
- Add Release Note line if needed:
- Release-note: Adds publication year to pull list.
contributing/core_committer_process.1740512266.txt.gz · Last modified: 2025/02/25 14:37 by tmccanna