raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Adding Code Reviews section and Source style section to the CONTRIBUTING.md

Browse source
This commit is contained in:
Viktor Klang 2012-09-24 15:20:27 +02:00
parent 429e8799a2
commit 99aeef3ee9
1 changed files with 26 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md
View file

@ -6,6 +6,7 @@ Greetings traveller!
* [Akka Contributor License Agreement](www.typesafe.com/contribute/cla) * [Akka Contributor License Agreement](www.typesafe.com/contribute/cla)
* [Akka Issue Tracker](http://doc.akka.io/docs/akka/current/project/issue-tracking.html) * [Akka Issue Tracker](http://doc.akka.io/docs/akka/current/project/issue-tracking.html)
* [Scalariform](https://github.com/mdr/scalariform)
##Workflow## ##Workflow##
@ -13,9 +14,10 @@ Greetings traveller!
we won't accept anything from anybody who has not signed it. we won't accept anything from anybody who has not signed it.
1. Find-or-create a ticket in the issue tracker 1. Find-or-create a ticket in the issue tracker
2. Assign that ticket to yourself 2. Assign that ticket to yourself
3. Create a local branch with the following name format: wip-X-Y 3. Create a local branch with the following name format: wip-X-Y-Z
where the X is the number of the ticket in the tracker, where the X is the number of the ticket in the tracker,
and Y is your initials or similar. and Y is some brief keywords of the ticket title and Z is your initials or similar.
Example: wip-2373-add-contributing-md-√
4. Do what needs to be done (with tests and docs if applicable). 4. Do what needs to be done (with tests and docs if applicable).
Your branch should pass all tests before going any further. Your branch should pass all tests before going any further.
5. Push the branch to your clone of the Akka repository 5. Push the branch to your clone of the Akka repository
@ -32,4 +34,25 @@ Greetings traveller!
11. Pull Request is either merged by the Akka committers, 11. Pull Request is either merged by the Akka committers,
or rejected, and the associated ticket will be updated to or rejected, and the associated ticket will be updated to
reflect that. reflect that.
12. Delete the local and remote wip-X-Y 12. Delete the local and remote wip-X-Y-Z
##Code Reviews##
Akka utilizes peer code reviews to streamline the codebase, reduce the defect ratio,
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.
* 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,
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.
##Source style##
Akka uses [Scalariform](https://github.com/mdr/scalariform) to enforce some of the code style rules.