diff options
author | Jeff Quast <jquast@io.com> | 2015-05-09 15:02:02 -0700 |
---|---|---|
committer | Jeff Quast <jquast@io.com> | 2015-05-09 15:11:31 -0700 |
commit | ca33be09d78b755070e7e2d1a449f267e0fa74aa (patch) | |
tree | f395fc375350e4d8feca742124f68936f7f25938 | |
parent | ff3dc793fdcf6b0843443b15bf327d7bbae8a1e0 (diff) | |
download | blessings-ca33be09d78b755070e7e2d1a449f267e0fa74aa.tar.gz |
reverse symlink CONTRIBUTING, docs/contributing.py
When creating a PR, a hyperlink "Please review the guidelines
for contributing to this repository" is displayed, but previously
pointed to a symlink record and does not follow it.
Reverse direction of symlink, as sphinx-build happily follows
and will not affect the documentation.
l--------- | CONTRIBUTING | 1 | ||||
-rw-r--r-- | CONTRIBUTING.rst | 42 | ||||
l---------[-rw-r--r--] | docs/contributing.rst | 43 |
3 files changed, 43 insertions, 43 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 120000 index 7c5f320..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1 +0,0 @@ -docs/contributing.rst
\ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..7018671 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,42 @@ +Contributing +============ + +We welcome contributions via GitHub pull requests: + +- `Fork a Repo <https://help.github.com/articles/fork-a-repo/>`_ +- `Creating a pull request + <https://help.github.com/articles/creating-a-pull-request/>`_ + +Developing +---------- + +Install git, Python 2 and 3, pip, and tox. + +Then, from the blessings code folder:: + + pip install --editable . + +Running Tests +~~~~~~~~~~~~~ + +Install and run tox + +:: + + pip install --upgrade tox + tox + +Test Coverage +~~~~~~~~~~~~~ + +Blessings has 99% code coverage, and we'd like to keep it that way, as +terminals are fiddly beasts. Thus, when you contribute a new feature, make sure +it is covered by tests. Likewise, a bug fix should include a test demonstrating +the bug. + +Style and Static Analysis +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The test runner (``tox``) ensures all code and documentation complies +with standard python style guides, pep8 and pep257, as well as various +static analysis tools. diff --git a/docs/contributing.rst b/docs/contributing.rst index 7018671..798f2aa 100644..120000 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,42 +1 @@ -Contributing -============ - -We welcome contributions via GitHub pull requests: - -- `Fork a Repo <https://help.github.com/articles/fork-a-repo/>`_ -- `Creating a pull request - <https://help.github.com/articles/creating-a-pull-request/>`_ - -Developing ----------- - -Install git, Python 2 and 3, pip, and tox. - -Then, from the blessings code folder:: - - pip install --editable . - -Running Tests -~~~~~~~~~~~~~ - -Install and run tox - -:: - - pip install --upgrade tox - tox - -Test Coverage -~~~~~~~~~~~~~ - -Blessings has 99% code coverage, and we'd like to keep it that way, as -terminals are fiddly beasts. Thus, when you contribute a new feature, make sure -it is covered by tests. Likewise, a bug fix should include a test demonstrating -the bug. - -Style and Static Analysis -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The test runner (``tox``) ensures all code and documentation complies -with standard python style guides, pep8 and pep257, as well as various -static analysis tools. +../CONTRIBUTING.rst
\ No newline at end of file |