Contribute

Contribute to the Code

Git Workflow

1. Fork this repo.
2. Run git clone -b <yourbranch> <yourfork>.
3. From within the project root directory run pip install.
4. Develop!
5. Cover your code in /tests.
6. Create a pull request to the forcedotcom:developer branch.

How to Format Your Code

We recommend pep8 Style Guide for Python the best you can. We also encourage using autopep8 for automatic formatting.

Contribute to the Documentation

The tools used for documentation are:

• Read The Docs: An open source platform for automating, building, versioning, and hosting documentation. For more information see Read the Docs: Documentation Simplified.
• Sphinx: Sphinx simplifies creating intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources). For more information on installation and usage, see Getting Started sith Sphinx.

Documentation file format is reStructuredText. Learn more with this handy primer.