diff options
| author | Seth Tisue <seth@tisue.net> | 2015-07-16 08:14:57 -0400 |
|---|---|---|
| committer | Seth Tisue <seth@tisue.net> | 2015-07-16 08:14:57 -0400 |
| commit | e136e4ad473623cc6b88652589e1a38c2ccbf440 (patch) | |
| tree | edc54144e8386ab401bc6928398b1164b1efc2ca /CONTRIBUTING.md | |
| parent | f9ca6863d46ede2b8ce4b7753c5c54120c0864ad (diff) | |
| download | scala-e136e4ad473623cc6b88652589e1a38c2ccbf440.tar.gz scala-e136e4ad473623cc6b88652589e1a38c2ccbf440.tar.bz2 scala-e136e4ad473623cc6b88652589e1a38c2ccbf440.zip | |
tighten up CONTRIBUTING.md a little
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9471830571..e6557d78dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,13 +57,11 @@ If testing isn't feasible, the commit message should explain why. New features and enhancements must be supported by a respectable test suite. -Consider including comments in the test files that indicate what you're testing and why. Expected outcome, what happened before the fix, what happens now, that sort of thing. - Some characteristics of good tests: +* includes comments: what is being tested and why? * be minimal, deterministic, stable (unaffected by irrelevant changes), easy to understand and review * have minimal dependencies: a compiler bug test should not depend on, e.g., the Scala library -* typically fail before your fix is applied (so we see that you are fixing a legitimate bug) and should obviously pass after your fix ### Documentation @@ -71,7 +69,7 @@ This is of course required for new features and enhancements. Any API additions should include Scaladoc. -Don't forget to update the package-level doc (in the package object), if appropriate. +Consider updating the package-level doc (in the package object), if appropriate. ### Coding standards @@ -106,7 +104,7 @@ When working on maintenance branches (e.g., 2.11.x), include "[nomerge]" if this commit should not be merged forward into the next release branch. -Here are is standard advice on good commit messages: +Here is standard advice on good commit messages: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ### Pass Scabot |