diff --git a/doc/development/quickstart.txt b/doc/development/quickstart.txt index 6bcc5ee3c0f..c053c0e580b 100644 --- a/doc/development/quickstart.txt +++ b/doc/development/quickstart.txt @@ -15,19 +15,29 @@ 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 ` -* 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 ` + 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 ` +* 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 `. + + - The body of the commit message should explain or justify the change. + Read the :ref:`»» Detailed Commit Message Rules ` + for more information. + +* Provide tests that cover your changes and try to run the tests locally + first. * Submit pull-requests against the ``develop`` branch. @@ -35,10 +45,16 @@ Quick-start |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 ` + with a ``git push --force``. + (Scary! But github doesn’t play nicely with a safer method.) .. include:: ../_common_definitions.txt