Skip to content

Latest commit

 

History

History
73 lines (56 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

73 lines (56 loc) · 3.1 KB

Contributing to this repository

Help us to make this project better by contributing. Whether it's new features, bug fixes, or simply improving documentation, your contributions are welcome. Please start with logging a github issue or submit a pull request.

Before you contribute, please review these guidelines to help ensure a smooth process for everyone.

Thanks.

Opening issues

For bugs or enhancement requests, please file a GitHub issue unless it's security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions in our security policy.

  • Please browse our existing issues before logging new issues.
  • Check that the issue has not already been fixed in the main branch.
  • Open an issue with a descriptive title and a summary.
  • Please be as clear and explicit as you can in your description of the problem.
  • Please state the version of Clojure and Clara you are using in the description.
  • Include any relevant code in the issue summary.

Contributing code

We welcome your code contributions. Before submitting code via a pull request, you will need to have signed the Oracle Contributor Agreement (OCA) and your commits need to include the following line using the name and e-mail address you used to sign the OCA:

Signed-off-by: Your Name <[email protected]>

This can be automatically added to pull requests by committing with --sign-off or -s, e.g.

git commit --signoff

Only pull requests from committers that can be verified as having signed the OCA can be accepted.

Pull request process

  • Read how to properly contribute to open source projects on Github.
  • Fork the project.
  • Use a feature branch.
  • Write good commit messages.
  • Use the same coding conventions as the rest of the project.
  • Commit locally and push to your fork until you are happy with your contribution.
  • Make sure to add tests and verify all the tests are passing when merging upstream.
  • Add an entry to the Changelog accordingly.
  • Please add your name to the CONTRIBUTORS.md file. Adding your name to the CONTRIBUTORS.md file signifies agreement to all rights and reservations provided by the License.
  • Squash related commits together.
  • Open a pull request.
  • The pull request will be reviewed by the community and merged by the project committers.

Code of conduct

Follow the Golden Rule. If you'd like more specific guidelines, see the Contributor Covenant Code of Conduct.