git guidelines
This commit is contained in:
parent
4903435659
commit
1c78a21eb8
3 changed files with 29 additions and 0 deletions
21
doc/GIT.md
Normal file
21
doc/GIT.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# Using git
|
||||
|
||||
## Howto
|
||||
|
||||
## Guidelines
|
||||
|
||||
### Commit message
|
||||
|
||||
You can drink&code, but you can't drink&git!
|
||||
|
||||
git config --local commit.template doc/gitmessage
|
||||
|
||||
As the message explains, please add a prefix to your commit showing the "subject" of your commit.
|
||||
If your commit covers too many topic, it might be that it is just wrong.
|
||||
However, sometimes it is fine: for example, if you write some PHP code on tt-rss which adds a new dependency
|
||||
on some PHP extension, you will need to add that dependency into Dockerfile-tt-rss. So, both [D] and [TT]
|
||||
could apply.
|
||||
When multiple subjects apply, choose which is more important to you. 2 prefixes are allowed, if you really
|
||||
think so.
|
||||
Remember: if we wanted to know what changed in your commit, we would use git log --stat. The commit prefix
|
||||
should catch the "spirit" of the commit.
|
8
doc/gitmessage
Normal file
8
doc/gitmessage
Normal file
|
@ -0,0 +1,8 @@
|
|||
|
||||
|
||||
# [D] = differences in docker{,-compose}; [TT] = tt-rss; [BR] = rss-bridge
|
||||
# First line is WHY (50chars), should complete the sentence
|
||||
# If applied, this commit will...
|
||||
# Body is WHAT
|
||||
# Never explain how: the diff itself will
|
||||
# Best practice: http://chris.beams.io/posts/git-commit/
|
Loading…
Reference in a new issue