New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New commit guidelines #3466

Merged
merged 3 commits into from Apr 24, 2018

Conversation

Projects
None yet
3 participants
@htgoebel
Member

htgoebel commented Apr 16, 2018

This is a draft for new commit guidelines. This emphasis on

  • clean history
  • good commit messages
  • cleaning up commit history prior to push.

(The rearrangement of the text is less relevant.)

@pyinstaller/core-developers @pyinstaller/contributors @pyinstaller/hook-maintainers @pyinstaller/issue-contributors Your comments are welcome!

* Make small patches (i.e. work in consistent increments).
* Reformatting code without functional changes will generally not be
accepted (for rational see :issue:`2727`).

This comment has been minimized.

@bjones1

bjones1 Apr 16, 2018

Member

rationale, not rational.

This comment has been minimized.

@htgoebel

htgoebel Apr 24, 2018

Member

Thanks for spotting the typos.

* Reformatting code without functional changes will generally not be
accepted (for rational see :issue:`2727`).
If such changes are required, separate it into a commit of it own
and document as such.

This comment has been minimized.

@bjones1

bjones1 Apr 16, 2018

Member

its own, not it own.

@Suzumizaki

This comment has been minimized.

Contributor

Suzumizaki commented Apr 23, 2018

How to do when Appveyor or Travis-CI fails but the committer seems not responsible? :)

htgoebel added some commits Apr 16, 2018

Doc: Remove section "How to write good commit messages".
This section felt duplicate since quite some time now. Most or
the information is (or will soon) be contained in other sections.
Only keep the link the FreeBSD Committer's Guide, where this was
excerpted from.

[skip ci]
Doc: Overhaul guidelines for commit and commit-messages.
* Move "Guidelines for Commits" from quickstart to commit-messages,
  while reworking it.

* Split "Content of the commit message" into an intro, "the 1st line",
  and "the body", reworking it.

[skip ci]

@htgoebel htgoebel force-pushed the htgoebel:new-commit-guidelines branch from 8b6a836 to 789d350 Apr 24, 2018

@htgoebel htgoebel merged commit b31794c into pyinstaller:develop Apr 24, 2018

1 check was pending

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details

@htgoebel htgoebel deleted the htgoebel:new-commit-guidelines branch Apr 24, 2018

@htgoebel htgoebel added this to the PyInstaller 3.4 milestone Sep 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment