- Each commit message should start with prefix which contains hash and issue number, for example "#132"
- Commits which doesn't affect project build status like updating docs files "README.md" doesn't have to build by Github action. To do that commit message should contain sufix "[skip ci]"
Try to name your branch based on type of issue related to it, for example:
-
Feature - Prefix "feature/", issue number and some short description, for example:
Branch name for feature related to integration with Travis CI and with number 113. "feature/113_travis_integration"
-
Bugfix - Prefix "bugfix/", issue number and some short description, for example:
Branch name for bugfix related to NullPointer exception and with number 227. "bugfix/227_nullpointer_exception"
A developer who adds changes should implement tests that cover added code for any bug or a new feature. There should be added unit tests for any new code generally (there might be exceptions). If a developer does not have an idea for unit tests, can always ask about this in a comment for pull-request.
A developer should also implement integration tests if the applied changes for new code or already existing change somehow how the SQL is being generated. Tests should be implemented in core-functional-tests module.
Please report any typos or suggestions about document by creating an issue to the github project.
IN PROGRESS - suggestions are welcomed! Please be in mind that this document is still in progress. That means that if your have any suggestions or questions about this document or even whole project than please don't hesitate to write about. If you don't like to report your suggestions as issue than you can also write to me on my linkedin account