Commit f49034c9 by Piotr Mitros Committed by Matthew Mongeau

Grammar/formatting/spelling

parent 6fe49064
...@@ -2,7 +2,8 @@ Coding Standards ...@@ -2,7 +2,8 @@ Coding Standards
Scope Scope
This document describes code quality standards for the i4x system. Code falls into four categories: This document describes code quality standards for the i4x
system. Code falls into four categories:
* Deployed. Running on a live server. * Deployed. Running on a live server.
* Production. Intended for deployment. * Production. Intended for deployment.
...@@ -22,7 +23,8 @@ deploying. ...@@ -22,7 +23,8 @@ deploying.
Production Production
All production code must be peer-reviewed. The code must meet the following standards: All production code must be peer-reviewed. The code must meet the
following standards:
1) Test Suite. Code must have reasonable, although not complete, test 1) Test Suite. Code must have reasonable, although not complete, test
coverage. coverage.
...@@ -34,7 +36,7 @@ All production code must be peer-reviewed. The code must meet the following stan ...@@ -34,7 +36,7 @@ All production code must be peer-reviewed. The code must meet the following stan
6) Maintainability/Deployability 6) Maintainability/Deployability
7) Robust. 7) Robust.
All code paths must be manually or automatically verfied. All code paths must be manually or automatically verified.
Scaffolding Scaffolding
...@@ -45,7 +47,7 @@ following standards: ...@@ -45,7 +47,7 @@ following standards:
code to be structured such that it is possible to build tests. code to be structured such that it is possible to build tests.
2) Consistency. Code must follow PEP8 2) Consistency. Code must follow PEP8
3) Clean abstractions or obvious throw-away code. One of the goals 3) Clean abstractions or obvious throw-away code. One of the goals
of scaffolding is to define proper abstrations. of scaffolding is to define proper abstractions.
4) Future Compatibility. Code must not be incompatible with the 4) Future Compatibility. Code must not be incompatible with the
long-term vision of either the codebase or of edX. long-term vision of either the codebase or of edX.
5) Somewhat documented 5) Somewhat documented
...@@ -54,6 +56,6 @@ following standards: ...@@ -54,6 +56,6 @@ following standards:
Prototype Prototype
Prototype code should live in a seperate branch. It should strive Prototype code should live in a separate branch. It should strive
to follow PEP8, be readable, testable, and future-proof, but we have to follow PEP8, be readable, testable, and future-proof, but we have
no hard standards. no hard standards.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment