Skip to content

Commit 97c6030

Browse files
committed
Fixed #94 -- reference squashing commits in docs, many thanks to Docker for the general wording.
1 parent 14481e3 commit 97c6030

2 files changed

Lines changed: 19 additions & 4 deletions

File tree

docs/contributing/standards.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,22 @@ changes. Current test coverage can be found here:
8686
:target: https://coveralls.io/r/opdemand/deis?branch=master
8787
:alt: Coverage Status
8888

89-
Now create a GitHub pull request with a description of what your code
90-
fixes or improves. That's it!
9189

90+
.. _pull_request:
91+
92+
Pull Request
93+
------------
94+
Now create a GitHub `pull request`_ with a description of what your code
95+
fixes or improves.
96+
97+
Before the pull request is merged, make sure that you squash your
98+
commits into logical units of work using ``git rebase -i`` and
99+
``git push -f``. Include documentation changes in the same commit,
100+
so that a revert would remove all traces of the feature or fix.
101+
102+
Commits that fix or close an issue should include a reference like
103+
*Closes #XXX* or *Fixes #XXX* in the commit message. Doing so will
104+
automatically close the `GitHub issue`_ when the pull request is merged.
92105

93106
.. _Python: http://www.python.org/
94107
.. _flake8: https://pypi.python.org/pypi/flake8/
@@ -97,3 +110,5 @@ fixes or improves. That's it!
97110
.. _mccabe: https://pypi.python.org/pypi/mccabe/
98111
.. _PEP8: http://www.python.org/dev/peps/pep-0008/
99112
.. _`The Zen of Python`: http://www.python.org/dev/peps/pep-0020/
113+
.. _`pull request`: https://github.com/opdemand/pullrequests
114+
.. _`GitHub issue`: https://github.com/opdemand/issues

docs/releases.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Releases
2-
:description: Details the Deis release process. Deis releases.
2+
:description: Details the Deis release process. Deis releases.
33
:keywords: deis, release, process, build, tag
44

55
.. _releases:
@@ -51,7 +51,7 @@ Deis Repo
5151
Client
5252
------
5353

54-
- publish CLI to pip
54+
- publish CLI to pypi.python.org
5555
- ``python setup.py sdist upload``
5656
- use testpypi.python.org first to ensure there aren't any problems
5757

0 commit comments

Comments
 (0)