transmission-remote-gui / transgui

🧲 A feature rich cross platform Transmission BitTorrent client. Faster and has more functionality than the built-in web GUI.
GNU General Public License v2.0
3.24k stars 281 forks source link

Follow common convention about how to write commit message #1108

Open PeterDaveHello opened 6 years ago

PeterDaveHello commented 6 years ago

I wonder maybe it's about the time to discuss if we can use some common convention to write the git commit message, one of the most famous posts may be this: How to Write a Git Commit Message, following this convention can help:

  1. Make the commit message cleaner and easier to read
  2. Make the code tracing much more effective
  3. Make the release work less complex as it'll save time on writing changelog(history.txt)/release note

It might be a little bit like coding style, which helps unify the format, prevent to just write anything we developers thought but the others can't understand, may also make the contributions from the others be easier, as a hard to understand commit message will increase to gap to join.

This post says about the 7 rules:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

They are all mentioned somewhere else already before, like in the Pro Git book, some style guides from famous languages, frameworks, or developers(including Linus Torvalds), you can find the reference in that blog post.

What do you think @transmission-remote-gui/development ?

leonsoft-kras commented 6 years ago

there is no one to discuss. as solutions are now described - this is already good and a lot. )))