Before submitting new features or changes to current functionality, open an issue and discuss your ideas or propose the changes you wish to make. After a resolution is reached, a PR can be submitted for review.
Prior to contributing to the project, you can ensure your environment meets the following requirements:
- Valid Docker installation
- For the apps/pass-summary-api, OpenJDK-21 or newer
- For the apps/pass-api, go 1.22.5 or later
Code style follows the convention for the particular language - e.g. go fmt for golang.
When opening a pull request, please open it as a draft to not auto assign reviewers before you feel the pull request is in a reviewable state.
Pull request titles should briefly describe the proposed changes in a way that makes sense for the users.
They should be a sentence starting with an infinitive verb, and avoid using prefixes like [PROD] or PROD - .
Caution
Don't title:
- New feature: it doesn't describe the change
- npm package manager: it doesn't start with an infinite verb
Tip
Do instead: Add support for npm in Node.js
Note
If the changes don't make sense for the users, add the tag: no release note label.
After making you pull request ready for review by converting it from draft, you can expect getting an initial review comment within two working days, and a full review within a week of work. If you don't receive any update, feel free to send a nice reminder to the assigned reviewers using pull request comments.