-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added additional docs prior to 1.0 cut
- Loading branch information
Showing
5 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
************ | ||
Contributing | ||
************ | ||
|
||
* We are interested in various different kinds of improvement for Gilt; | ||
please feel free to raise an `Issue`_ if you would like to work on something | ||
major to ensure efficient collaboration and avoid duplicate effort. | ||
* Create a topic branch from where you want to base your work. | ||
* Check for unnecessary whitespace with ``git diff --check`` before committing. | ||
* Make sure you have added tests for your changes. | ||
* Run all the tests to ensure nothing else was accidentally broken. | ||
* Reformat the code by following the formatting section below. | ||
* Submit a pull request. | ||
|
||
Testing | ||
======= | ||
|
||
Dependencies | ||
------------ | ||
|
||
Install the test framework `Tox`_. | ||
|
||
.. code-block:: bash | ||
$ pip install tox | ||
Unit | ||
---- | ||
|
||
Unit tests are invoked by `Tox`_. | ||
|
||
.. code-block:: bash | ||
$ tox | ||
Formatting | ||
========== | ||
|
||
The formatting is done using `YAPF`_. | ||
|
||
From the root for the project, run: | ||
|
||
.. code-block:: bash | ||
$ tox -e syntax | ||
.. _`YAPF`: https://github.com/google/yapf | ||
.. _`Tox`: https://tox.readthedocs.io/en/latest | ||
.. _`Issue`: https://github.com/metacloud/gilt/issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../AUTHORS.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../CHANGELOG.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../../CONTRIBUTING.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,6 +93,9 @@ Similar Tools | |
.. toctree:: | ||
:maxdepth: 3 | ||
|
||
contributing | ||
changelog | ||
authors | ||
autodoc | ||
|
||
Indices and tables | ||
|