Skip to content

Commit

Permalink
Doc: Rework Quick-start guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
htgoebel committed Apr 16, 2018
1 parent 1f092e1 commit 8b6a836
Showing 1 changed file with 27 additions and 11 deletions.
38 changes: 27 additions & 11 deletions doc/development/quickstart.txt
Expand Up @@ -15,30 +15,46 @@ Quick-start
* Install required testing tools::

pip install -r tests/requirements-tools.txt

* Commit often and in logical chunks. Try to make small patches, consistent
increments. :ref:`»» Detailed Commit Guideline <Guidelines for Commits>`

* Provide tests that cover your changes and try to run the tests locally
first.
* Commit as often as you’d like, but squash or otherwise
rewrite your commits into logical patches before asking
for code review. ``git rebase -i`` is your friend.
Read the :ref:`»» Detailed Commit Guideline <Guidelines for Commits>`
for more information.

* Reformatting code without functional changes will generally not be accepted
Reformatting code without functional changes will generally not be accepted
(for rational see :issue:`2727`).

* Write meaningful commit messages in in the present tense, document what
you’re doing and why.
:ref:`»» Detailed Commit Message Rules <commit messages>`
* Write meaningful commit messages.

- The first line shall be a short sentence
that can stand alone as a short description of the change,
written in the present tense, and
prefixed with the :ref:`subsystem-name <commit message standard prefixes>`.

- The body of the commit message should explain or justify the change.
Read the :ref:`»» Detailed Commit Message Rules <commit messages>`
for more information.

* Provide tests that cover your changes and try to run the tests locally
first.

* Submit pull-requests against the ``develop`` branch.

* For new files mind adding the copyright header, see
|PyInstaller/init.py|_
(also mind updating to the current year).

.. |PyInstaller/init.py| replace:: :file`:PyInstaller/__init__.py`
.. _PyInstaller/init.py: https://github.com/pyinstaller/pyinstaller/blob/develop/PyInstaller/__init__.py
.. |PyInstaller/init.py| replace:: :file:`PyInstaller/__init__.py`
.. _PyInstaller/init.py: https://github.com/pyinstaller/pyinstaller/blob/develop/PyInstaller/__init__.py

* In response to feedback, squash the new "fix up" commits
into the respective commit that is being fixed
with an interactive rebase (``git rebase -i``).

* :ref:`Push the new, rewritten branch <updating pull-request>`
with a ``git push --force``.
(Scary! But github doesn’t play nicely with a safer method.)


.. include:: ../_common_definitions.txt
Expand Down

0 comments on commit 8b6a836

Please sign in to comment.