How to contribute
Guidelines for Bug Reporting
Bug Reports have to contain:
- Clear description of your expectations versus reality
- Runnable test case which isolates the bug and allows us to easily reproduce it on our laptops. You can push this test case to your fork of this repository.
Guidelines for Contributors
JaVers is an open source project, so we're open to your contributions.
In fact, if you need a new Feature, the best way is to contribute a Pull Request. Otherwise you just have to wait ...
Before you start to work please read these guidelines:
- Create the issue with a full description of the new Feature
- Consult the design with the JaVers team. You can chat with us on gitter
- Source code should be written in Java8.
- We aren't crazy about code formatting standards. Use 4 spaces to indent. Don't change the formatting of existing code.
- We really care about Clean Code and quality so expect many Code Review comments.
- Tests should be written in Spock/Groovy.
In JaVers, tests are well-crafted, runnable documentation.
Tests should specify and describe functionality, not implementation.
We fight Mocks. Stubs are allowed but discouraged.
- Commit message should mention the issue,
#299 new Guidelines for Contributors in README.md
- Before creating a Pull Request, merge from master and squash your commits
- Apply our Code Review comments and commit changes in the next commit. Please don't squash Code Review commits, we want to track the progress of the Code Review process.