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 is particularly appreciated.

The rst2html5 project is hosted on Heptapod by Octobus and Clever Cloud!

How to contribute

Please, follow the procedure:

  1. Check for the open issues or open a new issue on the Heptapod issue tracker to start a discussion about a feature or a bug.
  2. Fork the rst2html5 project and start making your modifications.
  3. Send a merge request.

Installing OS Packages

You will need:

  1. pipenv. A tool for installing and managing Python packages.
  2. Mercurial. Version control used by rst2html5 project.

Project Setup

$ hg clone https://foss.heptapod.net/doc-utils/rst2html5
$ cd rst2html5
$ pipenv install --dev
$ pipenv shell

Now you are ready!

Running the test suite

To run the tests, just type the following on a terminal:

$ nosetests

Important

Before sending a patch or a merge request, ensure that all tests pass and there is no flake8 error or warning codes.

Documentation

Contributing to documentation is as simple as editing the specified file in the docs directory. We use restructuredtext markup and Sphinx for building the documentation.

Reporting an issue

Proposals, enhancements, bugs or tasks should be directly reported on Heptapod 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:

  1. Steps to reproduce the bug
  2. The resulting output
  3. The expected output

Tip

See https://foss.heptapod.net/doc-utils/rst2html5/issues/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 merge requests. By submitting pull request your contribution to rst2html5 will be recorded by Heptapod.

Contacting the author

rst2html5 is written and maintained by André Felipe Dias. You can reach me at Twitter or by email (andre.dias@pronus.io).