Contributions are welcome! Look at the issue list. If there is something you think you can tackle, write about it in that issue and submit a Pull Request.
Please follow the issue template exactly when creating a new issue. I will be closing issues that do not follow that template. Please understand that maintaining this codebase takes time and I expect at least well-formatted issue statement to be able to tackle it. It is very demotivating to format the issues instead of the original submitter.
Please don't jump into creating a Pull Request straight away and open an issue first. This way, we can synchronize our views on the problem, so that everyone avoids losing time.
There are two branches:
master: should be stable and generally following the last release. Used for urgent bug fixing.dev: used to develop new features. Merges with master right before a new release.
- Line width is
80characters - Every public function should be documented.
- The code must pass linters:
pep8pep257: ignoring["D209", "D203", "D204", "D213", "D406", "D407"]
Please ensure, that your code conforms to this.
Most crucial functionality is covered with unit tests using UnitTesting Sublime Text plugin.
Whenever you contribute new functionality, please make sure it is covered by unit tests. It helps to maintain the quality of this software and to deal with all complex parts. I will not merge the PRs without unit tests covering the new functionality.