Skip to content

Commit e136e4a

Browse files
committed
tighten up CONTRIBUTING.md a little
1 parent f9ca686 commit e136e4a

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,19 @@ If testing isn't feasible, the commit message should explain why.
5757

5858
New features and enhancements must be supported by a respectable test suite.
5959

60-
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.
61-
6260
Some characteristics of good tests:
6361

62+
* includes comments: what is being tested and why?
6463
* be minimal, deterministic, stable (unaffected by irrelevant changes), easy to understand and review
6564
* have minimal dependencies: a compiler bug test should not depend on, e.g., the Scala library
66-
* typically fail before your fix is applied (so we see that you are fixing a legitimate bug) and should obviously pass after your fix
6765

6866
### Documentation
6967

7068
This is of course required for new features and enhancements.
7169

7270
Any API additions should include Scaladoc.
7371

74-
Don't forget to update the package-level doc (in the package object), if appropriate.
72+
Consider updating the package-level doc (in the package object), if appropriate.
7573

7674
### Coding standards
7775

@@ -106,7 +104,7 @@ When working on maintenance branches (e.g., 2.11.x), include "[nomerge]"
106104
if this commit should not be merged forward into the next release
107105
branch.
108106

109-
Here are is standard advice on good commit messages:
107+
Here is standard advice on good commit messages:
110108
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
111109

112110
### Pass Scabot

0 commit comments

Comments
 (0)