Grammatical improvements
Docker-DCO-1.1-Signed-off-by: Glyn Normington <gnormington@gopivotal.com> (github: glyn)
This commit is contained in:
parent
3ce18ef0b3
commit
6087476b48
|
@ -18,7 +18,7 @@ For instructions on setting up your development environment, please
|
||||||
see our dedicated [dev environment setup
|
see our dedicated [dev environment setup
|
||||||
docs](to be written).
|
docs](to be written).
|
||||||
|
|
||||||
## Contribution guidelines
|
## Contribution Guidelines
|
||||||
|
|
||||||
### Pull requests are always welcome
|
### Pull requests are always welcome
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# libcontainer principles
|
# libcontainer Principles
|
||||||
|
|
||||||
In the design and development of libcontainer we try to follow these principles:
|
In the design and development of libcontainer we try to follow these principles:
|
||||||
|
|
||||||
|
@ -6,13 +6,13 @@ In the design and development of libcontainer we try to follow these principles:
|
||||||
|
|
||||||
* Don't try to replace every tool. Instead, be an ingredient to improve them.
|
* Don't try to replace every tool. Instead, be an ingredient to improve them.
|
||||||
* Less code is better.
|
* Less code is better.
|
||||||
* Less components is better. Do you really need to add one more class?
|
* Fewer components are better. Do you really need to add one more class?
|
||||||
* 50 lines of straightforward, readable code is better than 10 lines of magic that nobody can understand.
|
* 50 lines of straightforward, readable code is better than 10 lines of magic that nobody can understand.
|
||||||
* Don't do later what you can do now. "//FIXME: refactor" is not acceptable in new code.
|
* Don't do later what you can do now. "//FIXME: refactor" is not acceptable in new code.
|
||||||
* When hesitating between 2 options, choose the one that is easier to reverse.
|
* When hesitating between two options, choose the one that is easier to reverse.
|
||||||
* No is temporary, Yes is forever. If you're not sure about a new feature, say no. You can change your mind later.
|
* "No" is temporary; "Yes" is forever. If you're not sure about a new feature, say no. You can change your mind later.
|
||||||
* Containers must be portable to the greatest possible number of machines. Be suspicious of any change which makes machines less interchangeable.
|
* Containers must be portable to the greatest possible number of machines. Be suspicious of any change which makes machines less interchangeable.
|
||||||
* The less moving parts in a container, the better.
|
* The fewer moving parts in a container, the better.
|
||||||
* Don't merge it unless you document it.
|
* Don't merge it unless you document it.
|
||||||
* Don't document it unless you can keep it up-to-date.
|
* Don't document it unless you can keep it up-to-date.
|
||||||
* Don't merge it unless you test it!
|
* Don't merge it unless you test it!
|
||||||
|
|
Loading…
Reference in New Issue