Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.98 KB

Contributing

Contributor Licence Agreement

We are asking all past and future contributors to sign a Contributor License Agreement (CLA). Every contributor of non-trivial amounts of code (more than just a line or two) to checkmate is required to sign a CLA. If somebody is unable to sign the CLA, the contribution (e.g., code, documentation, translations) has unfortunately to be removed from checkmate.

The CLA ensures that QuantifiedCode has clear licensing for all contributions to checkmate, which in turn lets us guarantee to users that we have no "stray" intellectual property or differently-licensed material.

Where do I sign? What's next?

  1. Download a copy of the CLA:

  2. Print out the CLA and sign it.

  3. Send the CLA to QuantifiedCode by scanning and emailing the document to cla@quantifiedcode.com

Learn more

Type of contributions

Report Bugs

Report bugs at https://github.com/quantifiedcode/checkmate/issues.

If you are reporting a bug, please include:

  • The trackeback of the error
  • Your operating system name and version
  • Any details about your local setup that might be helpful in troubleshooting
  • Detailed steps to reproduce the bug
  • A screenshots (if useful)

Fix Bugs

Go through the Github issues. Anything that is tagged as "bug" is open to whoever wants to implement it.

Add new features

Go through the Github issues. Anything tagged as "feature" is open to whoever wants to implement it.

Write Documentation

Checkmate can always get more documentation, whether as part of the official checkmate https://docs.quantifiedcode.com, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback and Propose Features

The best way to send feedback is to file an issue at https://github.com/quantifiedcode/checkmate/issues. Additionally, you can reach out to our team. We are looking forward getting in touch with you!

If you are proposing a feature:

  • Detailed description of the feature to be implemented
  • User story (if applicable)
  • Keep the scope as narrow as possible, to make it easier to implement
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)