diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa56d2849e..af10a1c2c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,14 +44,14 @@ increase maintainability and spread knowledge about how things are solved. Core review values: * Rule: [The Boy Scout Rule](http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule) - Why: Small improvements add up over time, keeping the codebase in shape. + - Why: Small improvements add up over time, keeping the codebase in shape. * Rule: [Don't Repeat Yourself](http://programmer.97things.oreilly.com/wiki/index.php/Don't_Repeat_Yourself) - Why: Repetitions are not maintainable, keeping things DRY makes it easier to fix bugs and refactor, + - Why: Repetitions are not maintainable, keeping things DRY makes it easier to fix bugs and refactor, since you only need to apply the correction in one place, or perform the refactoring at one place. * Rule: Feature tests > Integration tests > Unit tests - Why: Without proving that a feature works, the code is only liability, - Without proving that a feature works with other features, the code is of limited value, - Without proving the individual parts of a feature works, the code is harder to debug. + - Why: Without proving that a feature works, the code is only liability. + Without proving that a feature works with other features, the code is of limited value. + Without proving the individual parts of a feature works, the code is harder to debug. ##Source style## @@ -63,4 +63,4 @@ For external contributions of entire modules, the normal way is to establish it to show that there is a need for the module. The next step would be to add it to Akka as an "experimental module", then when the module is hardened, well documented and tested it becomes an officially supported Akka module. -[List of experimental Akka modules](http://doc.akka.io/docs/akka/current/experimental/index.html) \ No newline at end of file +[List of experimental Akka modules](http://doc.akka.io/docs/akka/current/experimental/index.html)