Debian Codegraph @

sites/www/development.rst

raw
1 ===========
2 Development
3 ===========
4
5 Obtaining a source checkout
6 ===========================
7
8 Our Git repository is maintained on Github at `pyinvoke/invoke`_. Please
9 follow their instructions for cloning (or forking, then cloning, which is best
10 if you intend to contribute back) the repository there.
11
12 Once downloaded, install the repo itself + its development dependencies by
13 running ``pip install -r dev-requirements.txt``.
14
15
16 Submitting bug reports or patches
17 =================================
18
19 We follow `contribution-guide.org`_ for all of our development - please `go
20 there`_ for details on submitting patches, which branch(es) to work out of,
21 and so on. Our issue tracker is on `our GitHub page`_.
22
23 Changelog location
24 ==================
25
26 Invoke's changelog lives in ``sites/www/changelog.rst`` and is formatted
27 using the `Releases <https://releases.readthedocs.io>`_ Sphinx plugin.
28
29 Running management tasks
30 ========================
31
32 Invoke uses itself for project management and has a number of tasks you can
33 see with ``inv --list``. Some specific tasks of note:
34
35 * ``test`` and ``integration``: Runs the primary and integration test
36 suites, respectively. (Most of the time you can ignore ``integration`` -
37 it's mostly for use by CI systems or once-in-a-while sanity checks
38 locally.)
39 * ``www`` and ``docs`` (and their subtasks like ``docs.browse``): Builds
40 the WWW site and the API docs, respectively.
41
42 Another good resource is to skim our ``.travis.yml`` file for the commands it
43 executes - if submissions don't pass all of those commands to some degree, they
44 won't pass Travis' CI builds either!
45
46
47 .. _go there:
48 .. _contribution-guide.org: https://contribution-guide.org
49
50 .. _our GitHub page:
51 .. _pyinvoke/invoke: https://github.com/pyinvoke/invoke