Add commit template - Githubissues

platisd / indoor-navigation-system

[WIP] An indoor navigation system to guide users towards their colleagues' desks

Apache License 2.0

15 stars 13 forks source link

Add commit template #54

Closed samup4web closed 6 years ago

samup4web commented 6 years ago

As a developer I would like to have a commit template to facilitate good commit messages

DoD

Script to configure git commit template according to project standard.

platisd commented 6 years ago

Do you have an example where this is used?

samup4web commented 6 years ago

A quick search - https://git-template.readthedocs.io/en/latest/

platisd commented 6 years ago

Hmmm, I still did not understand how will it help us. Will it run some checks over the commit contents (e.g. clang format) and not allow you to commit until you satisfy those checks?

samup4web commented 6 years ago

Basically it makes it easier to follow a uniform commit message format for all contributors/commits. When you run git commit, you will be presented with a specified template such as the one below

#Title: here goes nice good short title, gives highlight of what changes are >

#Details : <More details on why for need of changes> #Issue no : <if it issue no. , an issue raised if any>

Of course this can take any format we desire in the project.

platisd commented 6 years ago

Aha I see. Yes, we could have it like that, but maybe with comments instead (i.e. # added in front of every line) so a committer won't have to delete text every time.