Skip to content
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

[qa] Add commit message style check #20

Closed
nemesifier opened this issue Nov 18, 2018 · 1 comment · Fixed by #23
Closed

[qa] Add commit message style check #20

nemesifier opened this issue Nov 18, 2018 · 1 comment · Fixed by #23

Comments

@nemesifier
Copy link
Member

nemesifier commented Nov 18, 2018

It's time to automate the commit message style checks according to our guidelines, that will make contributing a lot smoother for new contributors and less time consuming for reviewers.

These are the most common issues which we should address:

  • prefix not present, eg: Done something (should be [qa] Done something)
  • no capital letter after prefix: [qa] done something
  • unnecessary final dot in first line, eg: [qa] Done something.
  • No blank line before first line and second line, eg:
[qa] Done something
Long description
  • Mentions an issue without closing it, eg: Implements #20 (won't close), Closes #20 and #21 (won't close #21 - but we should allow writing something like Related to #33, because sometimes we may want to reference an issue even though we are not solving it in that commit
  • Closes an issue in the long description but doesn't mention it in the short description, eg:
[qa] Done something

Fixes #2

should be:

[qa] Done something #2

Fixes #2

(easier to read in the short log format)

This is not urgent but not unimportant because having a clean commit history is important for the long term sustainability of the project.
It doesn't make sense to keep enforcing these rules by hand.. it's clear to me that as the community grows we won't be able to do that, so automating this check is key.

We need something like the migration check implemented in #16.

@nemesifier nemesifier added this to To do (general) in OpenWISP Contributor's Board via automation Nov 18, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 21, 2018
@ppabcd
Copy link
Contributor

ppabcd commented Nov 21, 2018

it's not clear.

ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 22, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 27, 2018
@atb00ker atb00ker moved this from To do (general) to In progress in OpenWISP Contributor's Board Nov 28, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
ppabcd added a commit to ppabcd/openwisp-utils that referenced this issue Nov 30, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
nemesifier added a commit that referenced this issue Dec 1, 2018
OpenWISP Contributor's Board automation moved this from In progress to Done Dec 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants