Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.34 KB

Contributing to Itzï

First of all, thanks to take time to contribute to Itzï. This is much appreciated. This file is a work in progress. It will be updated as time goes.

Code of Conduct

This project and everyone participating in it is governed by the Itzï Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected].

How Can I Contribute?

Reporting Bugs

If a developer don't know about a bug, he/she cannot fix it! Therefore, it is very valuable to thoroughly describe the problem you encounter on the bug-tracker.

Write documentation

Documentation is critical for all users, especially new ones. But writing good documentation is time consuming.

The documentation of Itzï is hosted on Readthedocs. It is written in reStructuredText and generated with Sphinx. The source code of the documentation lies on its own git repository.

Please use one sentence per line and try to keep line length under 90 characters. If above that threshold, break the line.

Code

Please have a look at the programer's manual.