EXERLOG / exer_log

exer_log - authored by @KalleHallden
MIT License
320 stars 85 forks source link

feat: convetional commits to create an explicit commit history #17

Closed AnsgarLichter closed 2 years ago

AnsgarLichter commented 2 years ago

I suggest to add a convention for the commit messages to ensure explicit commit messages. This makes it easier to create automated changelogs and other things.

I have used conventional commits including git hooks to validate the commit messages during every commit.

There are also other convetions for commits. The important thing is to use 1 convention consistently.

momshaddinury commented 2 years ago

This is pretty good one. 💯

KalleHallden commented 2 years ago

Great idea! Is the best way to add a section about commit conventions to the readme to inform people or how would you recommend doing it?

jaedag commented 2 years ago

You could also use a tool to enforce conventional commits in the repo. I've used something like that in my reacts projects.

I'll look into it to see if I can find anything similar for flutter since the project dependencies are not installed using npm

AnsgarLichter commented 2 years ago

Normally I use a tool which makes use of git hooks to enforce commit conventions. Unfortunately I have only used tools which can be installed via npm. I have used (Husky) in combination with Commitlint for conventional commits.

I hope there are similar libraries for flutter available. I found an alternative for husky: git_hooks. There is an alternative for commitlint, too:

The READMEs sound nice but I haven't used them myself. Hopefully some people know some of the available libraries and can make suggestions which ones to use. Neverthless the commit convetions should be mentioned in the project's README as well.

tenshiAMD commented 2 years ago

@KalleHallden Currently, we have mergeable to help check, I suggest using lefthook instead. I'm willing to help regarding this matter.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.