diff --git a/CONTRIBUTORS_GUIDE.md b/CONTRIBUTORS_GUIDE.md index 917e2c96..f3916f60 100644 --- a/CONTRIBUTORS_GUIDE.md +++ b/CONTRIBUTORS_GUIDE.md @@ -18,7 +18,7 @@ For instructions on setting up your development environment, please see our dedicated [dev environment setup docs](to be written). -## Contribution guidelines +## Contribution Guidelines ### Pull requests are always welcome diff --git a/PRINCIPLES.md b/PRINCIPLES.md index 5d337cdf..42396c0e 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -1,4 +1,4 @@ -# libcontainer principles +# libcontainer 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. * 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. * 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. -* No is temporary, Yes is forever. If you're not sure about a new feature, say no. You can change your mind later. +* 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. * 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 document it unless you can keep it up-to-date. * Don't merge it unless you test it!