Hi there! We’re thrilled that you are interested to contribute to this project. Your help is essential for keeping this Benchmark plugin great and making it even better for all of us.
If you would like to contribute code to the Benchmark plugin, you can do so by following these simple steps.
- Submit your idea by creating a Github
issue, - Associate the
issuewith the right label and project if one related exist.
Note: The issue is so that the maintainers are aware of your efforts, can comment, and finally, be ready to review and merge your changes.
- Fork this project Github master repository,
- Create a clone of your fork repository on your development machine,
- If necessary, create a feature branch based on
master:git checkout -b <my-branch-name> master.
Note: Contributions should be developed on branches based off the master branch of the Github master repository; and pull requests should be made back towards the master branch.
- Add the necessary code changes,
- Add unit tests,
- Verify that all the existing unit tests pass,
- Document your code changes (Javadoc & MD files).
- Push back regularly to your fork, and once the feature is complete to its
masterbranch, - Submit a pull request towards the
masterbranch of the Github master repository; and link the request to its originalissuein the comment, - Pat yourself in the back and wait for your pull request to be reviewed.
- Follow existing coding practices whenever possible,
- Document your code changes (Javadoc & MD files),
- Write tests and validate existing tests,
- Keep your change as focused as possible,
- When making multiple independent changes, please consider submitting them as separate pull requests,
- With each pull request, consider writing a good commit message.
Please log an issue through the Issues section of the Github master repository.