summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSeth Tisue <seth@tisue.net>2015-07-13 18:56:11 -0400
committerSeth Tisue <seth@tisue.net>2015-07-13 18:56:11 -0400
commit951939d1b35ebfd1ac1f1a96ca02cbff0c056b63 (patch)
tree3be70dd9236d0986f60f01296e14e5ba0ada46d6 /CONTRIBUTING.md
parent52fde52920d93325310e5544991feeea03e5c763 (diff)
downloadscala-951939d1b35ebfd1ac1f1a96ca02cbff0c056b63.tar.gz
scala-951939d1b35ebfd1ac1f1a96ca02cbff0c056b63.tar.bz2
scala-951939d1b35ebfd1ac1f1a96ca02cbff0c056b63.zip
contributor guide: add a morsel salvaged from GitHub wiki
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 54334aea48..e6e0e0b923 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -47,6 +47,7 @@ A new language feature requires a SIP (Scala Improvement Process) proposal. For
#### Summary
1. We require regression tests for bug fixes. New features and enhancements must be supported by a respectable test suite.
+ - Consider including comments in the test files that indicates what you're testing and why. Expected outcome, what happened before the fix, what happens now, that sort of thing.
2. Documentation. Yep! Also required :-)
3. Please follow these standard code standards, though in moderation (scouts quickly learn to let sleeping dogs lie):
- Not violate [DRY](http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself).