Closed Miseracle closed 7 years ago
1) Short commit message must not exceed 50 chars. All details should be moved to the "long" commit description. The commit must match pattern {{Action in present tense}} {{brief description}}
.
2) Use normal sentence style for commit messages: add whitespaces where you'd place them in typical human-readable text.
3) Commit 7023e16 Merge branch 'feature/pre-commit-integration' of https://github.com/Miseracle/my-first-blog into feature/pre-commit-integration
is a merge commit. Please try to avoid such things as they mess up your history log. The best approach is to use git pull --rebase
instead of just git pull
, this ensures that your local commits, which you haven't pushed yet are being rebased on top of ones fetched from remote, so that the history looks awesomely straightforward.
For merging:
Merge pull request
Squash and merge
option. I recommend this mode to ensure, that all changes from your feature will get into master as a single commit.Merge pull request
itself and edit the short and the long descriptions of your feature (merge) commit according to common rules for commits (e.g. short message may look like Integrate pre-commit into the repo
). You may also include Close #1
into your description and GitHub will automatically close issue #1 upon merge.Confirm squash and merge
. Bingo!
Add pre-commit tool, fixed various pep8 issues(docstrings etc.).