Obtaining a source checkout¶
Our Git repository is maintained on Github at pyinvoke/invoke. Please follow their instructions for cloning (or forking, then cloning, which is best if you intend to contribute back) the repository there.
Once downloaded, install the repo itself + its development dependencies by
pip install -r dev-requirements.txt.
Submitting bug reports or patches¶
Invoke’s changelog lives in
sites/www/changelog.rst and is formatted
using the Releases Sphinx plugin.
Running management tasks¶
Invoke uses itself for project management and has a number of tasks you can
inv --list. Some specific tasks of note:
integration: Runs the primary and integration test suites, respectively. (Most of the time you can ignore
integration- it’s mostly for use by CI systems or once-in-a-while sanity checks locally.)
docs(and their subtasks like
docs.browse): Builds the WWW site and the API docs, respectively.
Another good resource is to skim our
.travis.yml file for the commands it
executes - if submissions don’t pass all of those commands to some degree, they
won’t pass Travis’ CI builds either!