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: Commit messages #86

Open
Kreyren opened this issue Jul 24, 2019 · 7 comments · May be fixed by #90
Open

QA: Commit messages #86

Kreyren opened this issue Jul 24, 2019 · 7 comments · May be fixed by #90
Assignees

Comments

@Kreyren
Copy link
Contributor

Kreyren commented Jul 24, 2019

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

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

@nntoan nntoan self-assigned this Jul 26, 2019
Kreyren pushed a commit to RXT067/what-the-bash that referenced this issue Jul 26, 2019
Proposal to improve the efficiency of development on oh-my-bash project
Fixes: ohmybash#89
Fixes: ohmybash#88
Fixes: ohmybash#86
Partially Fixes: ohmybash#85
Partially Fixes: ohmybash#83
Signed-off-by: Jacob Hrbek <[email protected]>
@Kreyren Kreyren linked a pull request Jul 26, 2019 that will close this issue
@nntoan
Copy link
Member

nntoan commented Aug 14, 2019

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:

Screenshot 2019-08-14 11 53 34

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
Copy link
Member

@nntoan I like this proposal :)

@Kreyren Kreyren added P3 - Normal Priority 3 - Normal P1 - Very Important Priority 1 and removed P3 - Normal Priority 3 - Normal labels Aug 15, 2019
@Kreyren
Copy link
Contributor Author

Kreyren commented Aug 15, 2019

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

@Kreyren
Copy link
Contributor Author

Kreyren commented Aug 15, 2019

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

@nntoan
Copy link
Member

nntoan commented Aug 20, 2019

@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
Copy link
Contributor Author

Kreyren commented Aug 20, 2019

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
Copy link
Contributor Author

Kreyren commented Aug 20, 2019

image

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~~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants