Collaborate on the project


  1. Fork the project
  2. Make one or more well commented and clean commits to the repository.
  3. Perform a pull request in github’s web interface.

If it is a new feature request, don’t start the coding first. Remember to open an issue to discuss the new feature.

If you are struggling, check this detailed step by step guide on contributing.

Where are sources?

Build script:


Collaborate with Documentation

Documentation Workflow

  1. Contributor clones repo
  2. Contributor copies ex: templates/ to docs/
  3. Contributor creates content within the simple framework provided by template
  4. Contributor commits and pushes to repo
  5. post-commit job runs a more intelligent version of tools/ and generates new mkdocs.yml
  6. post-commit builds new docs site, pushes, builds PDF (maybe–unless extra curation is desired)
  7. Contributor is delighted that creating a single markdown file was all that was needed to impact the community
  8. Contributor is inspired to create more content – because it was soooooo easy.

Help with donations

If you find our project useful, then we’d really appreciate it if you’d consider contributing to the project however you can. Donating is the easiest – you can use PayPal and Bitcoin or you can buy us something from our wish list.