Contributing to rst2html5¶
Contributions are welcome! So don’t be afraid to contribute with anything that you think will be helpful. Help with maintaining the English documentation are particularly appreciated.
The bugtracker, wiki and Mercurial repository can be found at the rst2html5 projects’s page on BitBucket.
How to contribute¶
Please, follow the procedure:
Installing OS Packages¶
You will need:
- pip. A tool for installing and managing Python packages.
- virtualenvwrapper. A set of extensions to Ian Bicking’s virtualenv tool. Using a virtual environment will make the installation easier, and will help to avoid clutter in your system-wide libraries.
- Mercurial. Version control used by rst2html5 project.
sudo apt-get install python-dev python-pip mercurial sudo pip install virtualenvwrapper
Add these two lines to
export WORKON_HOME=$HOME/.virtualenvs source /usr/local/bin/virtualenvwrapper.sh
Clone the repository:
$ hg clone http://www.bitbucket.org/andre_felipe_dias/rst2html5 $ cd rst2html5
Make a new virtual enviroment for development:
$ mkvirtualenv rst2html5
Install project’s requirements:
$ pip install -r requirements.txt -r dev_test_requirements.txt
Now you are ready!
To come back to the virtualenv in another session,
use the command
Running the test suite¶
To run the tests, just type the following on a terminal:
To get a complete test verification, run:
The complete tests save some interesting metrics at
Before sending a patch or a pull request, ensure that all tests pass and there is no flake8 error or warning codes.
Contributing to documentation is as simple as
editing the specified file in the
We use restructuredtext markup and Sphinx for building the documentation.
Reporting an issue¶
Proposals, enhancements, bugs or tasks should be directly reported on BitBucket issue tracker.
If there are issues please let us know so we can improve rst2html5. If you don’t report it, we probably won’t fix it. When creating a bug issue, try to provide the following information at least:
- Steps to reproduce the bug
- The produced output
- The expected output
See https://bitbucket.org/andre_felipe_dias/rst2html5/issue/1 as a reference.
For proposals or enhancements, you should provide input and output examples. Whenever possible, you should also provide external references to articles or documentation that endorses your request.
While it’s handy to provide useful code snippets in an issue,
it is better for you as a developer to submit pull requests.
By submitting pull request your contribution to
rst2html5 will be recorded by BitBucket.