Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.43 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) 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 the code-is-beautiful repository.

The CLA ensures that we have a clear licensing for all contributions, 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 info@quantifiedcode.com

Learn more

Type of contributions

Report Bugs

Report bugs at https://github.com/quantifiedcode/code-is-beautiful/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)

Add new features/visualizations

Feel free to add your own visualization. You can also go through the Github issues. Anything tagged as "feature" is open to whoever wants to implement it.

Fix Bugs

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

Write documentation

"Code-is-beautiful" can always get more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.