search

semgit / semgit-spec-repository-naming

Semantic naming specification for Git repositories
11 stars 0 forks source link

Suggestion: Commit message guidelines #3

Open ghengeveld opened 9 years ago

ghengeveld commented 9 years ago

Perhaps semgit should also include guidelines for commit messages. Personally I'm a fan of Angular's guidelines although it's a bit limited and very project specific. I suggest the following types:

feat: Implements a feature fix: Fixes a bug docs: Documentation cs: Changes code style / fix linting errors refactor: Code rewrite/changes which does not change functionality test: Changes to automated test code perf: Performance enhancements chore: Changes to the build process or auxiliary tools and libraries design: Visual / UX design changes wip: Work in progress poc: Proof of concept / experiment

Here's a great article about commit messages: http://chris.beams.io/posts/git-commit/

It's possible to automate the commit message format by specifying a gitmessage template.

jvandemo commented 9 years ago

@ghengeveld — Great idea!

The original intention was to create a separate repository to specify commit message conventions in the future.

But since you already brought this up, we will create the repository already so ideas and discussions can start to develop organically.

Thanks for your feedback, looking forward to hear opinions on this.

jvandemo commented 9 years ago

To make this discussion relevant to repository naming, I would suggest calling the new repository for commit messages guidelines:

semgit-spec-commit-messages

This is based on the current repository naming convention.

Feel free to leave other suggestions. The final name can then be selected once the repository naming specification v1.0.0 is released.