Add CONTRIBUTING.md

2019-11-12 16:53:05 +08:00 · 2019-11-12 16:53:05 +08:00 · dc80b07983
parent 84aa2299dc
commit dc80b07983
1 changed files with 12 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,12 @@
+# Contributing to TCP Shaker
+
+## Styleguide
+### Git commit message
+
+- Capitalize the first letter ("Add feature" not "add feature")
+- Limit the first line to 50 characters or less
+- Details below the first line should be wrapped to 72 characters
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+
+Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and keeps the git log clean.