QA: Commit messages

[Kreyren]

Standardize commit messages so that searching in commit history is easier.

Referencing: https://github.com/wine-mirror/wine/commits/master

[nntoan]

Hi @Kreyren, I do agree that we should standardize commit messages. So here is my very first proposal for this.

Below is our repository structure:

oh-my-bash.sh

• All commits which change this file SHOULD USE the following commit message:

init: Fixed #GITHUB-ISSUE-NUMBER or Adding some new thing or Improve performance..etc

*.md / LICENSE / .github

• The commit message for all those files should look like this:

meta: Change something

aliases / plugins / completions / themes

• The following commit messages would be considered as acceptable:

aliases: Fixed #GITHUB-ISSUE-NUMBER
OR
chmod: Added new permission command

plugins: Fixed #GITHUB-ISSUE-NUMBER
OR
battery: Make battery great again

completions: Fixed #GITHUB-ISSUE-NUMBER
OR
git-avh: Doing something here

themes: Fixed #GITHUB-ISSUE-NUMBER
OR
agnoster: I updated nothing

custom

• The commit message for all files in this folder should look like this:

example: Do something cool

lib / templates

• The commit message for all files in this folder should look like this:

lib: For the greater good

tools/install.sh | tools/uninstall.sh

• The commit message for those files should look like this:

installer: I changed ABC XYZ

tools/upgrade.sh | tools/check_for_upgrade.sh

• The commit message for those files should look like this:

upgrader: Fixed this fixed that

tools

• The commit message for all other files in this folder should look like this:

tools: Added some new scripts

Please help me correct or let me know what's your thoughts regards this :)

Cheers, Toan

[rpotter12]

@nntoan I like this proposal :)

[Kreyren]

Assigned P1 since this is maintainance issue which should be investigated with P1

[Kreyren]

Currently we have 63 commits it might be worth it to fix the commit messages under P5 according to this issue.

[nntoan]

@rpotter12 Thanks :)

So if you guys all agree with this proposal, then I think it should be documented somewhere (best place is Wiki), linked it into the CONTRIBUTING.md for eg then we can resolve #93 .

Cheers,

cc @Kreyren

[Kreyren]

I think it should be documented somewhere (best place is Wiki), linked it into the CONTRIBUTING.md

Recommends using just link to CONTRIBUTING.md on wiki

[Kreyren]

i don't agree with this the commit message should only have summery and references on relevant issues/pull requests should be under it alike

`aliases: Fixes a b c d

DESCRIPTION

Fixes: #123456132

Signature (optional)

Which is standard for commits

> gnoster: I updated nothing

Also avoid using `I did something..` in commit messages since it's not professional ~~and it annoys me xD~~