Contributing¶

Talk¶

Suggestions, improvements and discussion:

TODO

Git branches¶

What follows is a table of the git branches used in md-toc’s repository. Please, do NOT open pull requests on the master, dev or gh-pages branches. Use bugfix-${fix_name} or newfeature-${new_feature_name} instead.

Branch	Description	Update schedule
`master`	the main branch	every new release
`dev`	recent changes are merged here before a new release	at will
`gh-pages`	contains the built documentation only	every new release
`bugfix-${fix_name}`	a generic bug fix
`newfeature-${new_feature_name}`	a generic new feature

Dependencies¶

First of all install the software requirements from the requirements.txt file in the repository’s root:

$ pip install -r requirements.txt

Unit tests¶

If you have changed parts of the source code you MUST take care of adding the corresponding unit tests. Once you have done that run the following command in a terminal:

$ python setup.py test

or simply:

$ make test

Python PEP compliancy¶

To be able to lint and test for PEP compliancy you need to run:

$ make pep

Documentation¶

You can edit and rebuild all this documentation with:

$ make doc

TODO and FIXME¶

Go in the repository’s root and then:

grep -e TODO -e FIXME -n */*.py

Contribution Steps¶

clone the repository
install the requirements
write code
write unit tests
run tests
run PEP linter and check
update relevant documentation, if necessary
pull request