summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Zaugg <jzaugg@gmail.com>2015-05-20 15:18:34 +1000
committerJason Zaugg <jzaugg@gmail.com>2015-05-20 15:18:34 +1000
commite9ba325ab0fd1d740740e7c8d731888c059079fa (patch)
treec6a7eddab9ef5014567b5582230118a76007fa16
parent2f1b5259188698501dbc8430f63972bf7bc68154 (diff)
parente07a77f79a064d983703d90c965ccfbbc14daa3d (diff)
downloadscala-e9ba325ab0fd1d740740e7c8d731888c059079fa.tar.gz
scala-e9ba325ab0fd1d740740e7c8d731888c059079fa.tar.bz2
scala-e9ba325ab0fd1d740740e7c8d731888c059079fa.zip
Merge pull request #4506 from scala/readme-git
Update README.md
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index ba269dd71f..5bcbbb6229 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ You'll need a Java SDK (6 or newer), Apache Ant (version 1.8.0 or above), and cu
## Git Hygiene
-As git history is forever, we take great pride in the quality of the commits we merge into the repository. The title of your commit will be read hundreds (of thousands? :-)) of times, so it pays off to spend just a little bit more time to polish it, making it descriptive and concise. Please take a minute to read the advice [most projects agree on](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), and stick to 50-60 characters for the first line, wrapping subsequent ones at 80 (at most).
+As git history is forever, we take great pride in the quality of the commits we merge into the repository. The title of your commit will be read hundreds (of thousands? :-)) of times, so it pays off to spend just a little bit more time to polish it, making it descriptive and concise. Please take a minute to read the advice [most projects agree on](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), and stick to 72 or fewer characters for the first line, wrapping subsequent ones at 80 (at most).
When not sure how to formulate your commit message, imagine you're writing a bullet item for the next release notes, or describing what the commit does to the code base (use active verbs in the present tense). When your commit title is featured in the next release notes, it will be read by a lot of curious Scala users, looking for the latest improvements. Satisfy their thirst for information with as few words as possible! Also, a commit should convey clearly to your (future) fellow contributors what it does to the code base.