Hackersh is under active development, and contributors are welcome.
If you have a feature request, suggestion, or bug report, please open a new issue on GitHub.
Before we can accept code, patches or pull requests on GitHub, there’s a quick web form we need you to fill out here (scroll to the bottom!).
Hackersh’s CLA is a copy of the one used by Sun Microsystems for all contributions to their projects.
This particular agreement has been used by other software projects in addition to Sun and is generally accepted as reasonable within the Open Source community.
Hackersh source is controlled with Git, the lean, mean, distributed source control machine.
The repository is publicly accessable.
git clone git://github.com/ikotler/hackersh.git
The project is hosted on GitHub.
Feature / Hotfix / Release branches follow a Successful Git Branching Model. Git-flow is a great tool for managing the repository. I highly recommend it.
Each release is tagged.
When submitting patches, please place your feature/change in its own branch prior to opening a pull reqeust on GitHub.
TBD
Documentation is written in the powerful, flexible, and standard Python documentation format, reStructured Text. Documentation builds are powered by the powerful Pocoo project, Sphinx. The API Documentation is mostly documented inline throughout the module.
The Docs live in hackersh/doc. In order to build them, you will first need to install Sphinx:
$ pip install sphinx
Then, to build an HTML version of the docs, simply run the following from the doc directory:
$ make html
Your doc/_build/html directory will then contain an HTML representation of the documentation, ready for publication on most web servers.
You can also generate the documentation in epub, latex, and json.