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] Enforce conventional commit style #110

Open
nemesifier opened this issue May 19, 2020 · 2 comments
Open

[qa] Enforce conventional commit style #110

nemesifier opened this issue May 19, 2020 · 2 comments

Comments

@nemesifier
Copy link
Member

nemesifier commented May 19, 2020

Read OpenWISP Commit conventions: openwisp/openwisp-docs#109

I still think we should keep consistency with what we've done until now, so I would use "feature" instead of "feat.
The prefix can be in square brackets, eg: [feature], [change].
Ensure first letter after ] is capital letter.
We should use the same keywords of conventional commits, with the exception of "feat" which is better spelt "feature", 3 characters are worth it in my opinion in this case.
We should also add [change] to the allowed prefixes.

We could then add a commit message template like this: https://thoughtbot.com/blog/better-commit-messages-with-a-gitmessage-template we can try it here first and then replicate it in the other modules.

Maybe we could ditch our own commit check solution in favor of a standard one, I just found this tool which looks really interesting!
https://commitizen-tools.github.io/commitizen/

This change will help us to generate change logs more easily later on.

@nemesifier nemesifier added this to To do in Hacktoberfest 2020 May 19, 2020
@nemesifier nemesifier added this to To do (docs) in Roadmap May 19, 2020
@atb00ker atb00ker added the Hacktoberfest Easy issues for attracting Hacktoberfest participants. label Sep 23, 2020
@atb00ker atb00ker moved this from To do to temp-atb00ker-will-remove-in-some-hours in Hacktoberfest 2020 Sep 23, 2020
@atb00ker atb00ker moved this from temp-atb00ker-will-remove-in-some-hours to Linux | Shell Scripting in Hacktoberfest 2020 Sep 23, 2020
@atb00ker atb00ker moved this from Linux | Shell Scripting to Docker | Ansible in Hacktoberfest 2020 Sep 23, 2020
@nemesifier nemesifier moved this from Docker | Ansible | Shell to Python | Django in Hacktoberfest 2020 Sep 30, 2020
@nemesifier nemesifier moved this from Python | Django to Documentation / QA in Hacktoberfest 2020 Sep 30, 2020
@devkapilbansal
Copy link
Member

devkapilbansal commented Nov 11, 2020

@nemesisdesign can we create pre-commit hooks too to ensure that basic checks works correctly before making a commit. Occasionally new contributors forget to run openwisp-qa-format or following flake guidelines due to which build failed.

@nemesifier
Copy link
Member Author

@devkapilbansal I won't be able to help with this now, it's useful to do it but not more important than releasing new features and helping the community to use the work we've been doing, for these reasons I'm urging all the contributors to focus on the issues in https://github.com/orgs/openwisp/projects/4 at least until we have released openwisp-controller 0.8, openwisp-monitoring 0.1, openwisp-firmware-upgrader 0.1 and openwisp-ipam 0.2.

@nemesifier nemesifier removed the Hacktoberfest Easy issues for attracting Hacktoberfest participants. label Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Roadmap
  
To do (docs)
Hacktoberfest 2020
  
Documentation / QA
Development

No branches or pull requests

3 participants