Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 2.66 KB
Raw

Contributing to CATS

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We Develop with Github

We use Github to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code doesn't introduce new code quality violations. Use Sonarqube with the default profile.
  6. Issue that pull request!

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Any contributions you make will be under the Apache 2.0 Software License

When you submit code changes, your submissions are understood to be under the same Apache 2.0 that covers the project. Feel free to contact the maintainers at [email protected] if that's a concern.

Report bugs using Github's issues

We use Github issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

We use JetBrains's IntelliJ's default Java coding style. In summary:

  • indent with 4 spaces
  • 120 characters line length

And also please consider to:

  • run a mvn sonar:sonar to check for code quality violations

License

By contributing, you agree that your contributions will be licensed under Apache 2.0 License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft and https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62

Code of Conduct

Please refer to Code of Conduct