2. Contribution Guide¶
This is a guide for all contributions to Qualia2.0. The development of Qualia2.0 is running on the official GitHub repository.
2.1. Branches¶
master
branch contains the most up-to-date source tree that includes features newly added after the latest major version.
The stable version is developed at the individual branch named as ‘vX’ with major version X.
2.2. Issues and Pull Requests¶
Multiple tags might be labeled to one issue or pull requests. Issues and Pull Requests are labeled by the following tags:
Bug: bug reports (issues) and bug fixes (pull requests)
Improvement: implementation improvements without breaking the interface
Feature: feature requests (issues) and their implementations (pull requests)
Docs: document fixes and improvements
Example: fixes and improvements on the examples
Install: fixes and updates on installation script
Other: other issues and pull requests
2.3. Documentation¶
When adding a new feature to the framework, the corresponding documentation is required.
To build the documentation, you need to install Sphinx:
$ pip install sphinx sphinx_rtd_theme nbsphinx
Then you can build the documentation in HTML format locally:
$ ./build_docs.sh
HTML files are generated under /html directory. Open index.html
with the browser and see if it is rendered as expected.