Refactoring contributing guidelines.
This commit is contained in:
@ -1,7 +1,7 @@
|
|||||||
# Contributing
|
# Contributing
|
||||||
## Coding guidelines
|
## Coding guidelines
|
||||||
|
|
||||||
- Two spaces indentation, Ruby style.
|
- Two spaces indentation.
|
||||||
- CamelCase for classes.
|
- CamelCase for classes.
|
||||||
- camelCase for methods & variables.
|
- camelCase for methods & variables.
|
||||||
- Max line length at 80 chars.
|
- Max line length at 80 chars.
|
||||||
@ -9,4 +9,4 @@
|
|||||||
- Classes can be no longer than 100 LOC.
|
- Classes can be no longer than 100 LOC.
|
||||||
- Methods can be no longer than 5 LOC.
|
- Methods can be no longer than 5 LOC.
|
||||||
- Pass no more than 4 parameters/hash keys into a method.
|
- Pass no more than 4 parameters/hash keys into a method.
|
||||||
- Routes can instantiate only one object. Therefore, views can only know about one instance variable and views should only send messages to that object ($object->collaborator->value is not allowed).
|
- Routes can instantiate only one object.
|
||||||
|
Reference in New Issue
Block a user