These guidelines are meant to be a living document that should be changed and adapted as needed. We encourage changes that make it easier to achieve our goals in an efficient way.
This is the process for committing code to the ari-proxy project. There are of course exceptions to these rules, for example minor changes to comments and documentation, fixing a broken build etc.
- Make sure you have signed the retel.io CLA.
- Before starting to work on a feature or a fix, it's good practice to ensure that:
- There is a ticket for your work in the project's issue tracker;
- The ticket has been discussed and prioritized by the team.
- Fork the project and perform your work in your own git branch (that is, use the GitHub Flow). Please make sure you adhere to the Semantic Commit Messages format.
- When the feature or fix is completed you should open a Pull Request on GitHub.
- The Pull Request will then be reviewed.
- After the review, you should resolve issues brought up by the reviewers as needed, iterating until the reviewers give their thumbs up.
- Once the code has passed review the Pull Request can be merged.
We use spotless to gradually enforce Google Java Style. Your build will fail, if changed files do not comply with the formatting guidelines. To automatically format your changed files correctly, run mvn spotless:apply.