The process for making code changes within the UL API team is generally as follows:
- Create an issue in GitHub to track the work.
- Discuss the issue with the team and agree on whether/how to proceed.
- Fork the code locally if you have not already done so.
- Create a local branch whose name matches the GitHub issue. If the issue number is #3, the branch should be
GH-3. - Make the changes agreed in step 2. All commit messages should be prefixed with the branch/issue details, i.e.
GH-3: Updated key dependencies. - Create a pull request comparing your fork/branch to
main. - Discuss the review with the team and agree on how/when it will be reviewed.
- Work together with reviewer(s) to address any feedback.
A pull request is more likely to be accepted if it:
- Makes a small, clearly identified, and well described change.
- Does not break any tests.
- Includes tests for any new functionality, so that the code coverage remains high.
- Passes all linting checks. This sometimes involves reformatting code to match the existing style. It can also involve discussing and making changes to the linting checks.