Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.05 KB

CONTRIBUTING.adoc

File metadata and controls

44 lines (35 loc) · 2.05 KB
Raw

Contributing

License Agreement

By contributing changes to this repository, you agree to license your contributions under the Apache 2 license. This ensures your contributions have the same license as the project and that the community is free to use your contributions. You also assert that you are the original author of the work that you are contributing unless otherwise stated.

Submitting an Issue

We use the issue tracker on GitHub associated with this project to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn’t already been submitted. When submitting a bug report, please include a Gist that includes any details that may help reproduce the bug.

Submitting a Pull Request

  1. Fork the repository.

  2. Build the project gradlew build.

  3. Before commits or pushes run gradlew -i codenarcAll.

    • If there are errors fix them.

    • It may be the case where the errors or warnings are necessary. If that is the case, ask before ignoring them.

  4. If you made multiple commits make sure you squash the commits.

  5. Submit the merge request.

For ideas about how to use pull requests, see the post Useful GitHub Patterns.

Coding Conventions

  1. Deprecated methods should have updated javadoc indicating which method to use unstead.

  2. Tests using Spock framework should have full sentences without underscores.

  3. If you are adding a new test that fixes a created issue, add the link to the issue by writing @Issue(<link-to-the-issue-at-git).

  4. Update the author tag to the files you have created or updated.

  5. Add @Since <version-number> to the file javadoc.