You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-5Lines changed: 3 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -57,21 +57,19 @@ If testing isn't feasible, the commit message should explain why.
57
57
58
58
New features and enhancements must be supported by a respectable test suite.
59
59
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
-
62
60
Some characteristics of good tests:
63
61
62
+
* includes comments: what is being tested and why?
64
63
* be minimal, deterministic, stable (unaffected by irrelevant changes), easy to understand and review
65
64
* 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
67
65
68
66
### Documentation
69
67
70
68
This is of course required for new features and enhancements.
71
69
72
70
Any API additions should include Scaladoc.
73
71
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.
75
73
76
74
### Coding standards
77
75
@@ -106,7 +104,7 @@ When working on maintenance branches (e.g., 2.11.x), include "[nomerge]"
106
104
if this commit should not be merged forward into the next release
107
105
branch.
108
106
109
-
Here are is standard advice on good commit messages:
0 commit comments