Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
f49034c9
Commit
f49034c9
authored
Jun 11, 2012
by
Piotr Mitros
Committed by
Matthew Mongeau
Jun 21, 2012
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Grammar/formatting/spelling
parent
6fe49064
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
5 deletions
+7
-5
doc/code_standards.txt
+7
-5
No files found.
doc/code_standards.txt
View file @
f49034c9
...
...
@@ -2,7 +2,8 @@ Coding Standards
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.
* Production. Intended for deployment.
...
...
@@ -22,7 +23,8 @@ deploying.
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
coverage.
...
...
@@ -34,7 +36,7 @@ All production code must be peer-reviewed. The code must meet the following stan
6) Maintainability/Deployability
7) Robust.
All code paths must be manually or automatically verfied.
All code paths must be manually or automatically ver
i
fied.
Scaffolding
...
...
@@ -45,7 +47,7 @@ following standards:
code to be structured such that it is possible to build tests.
2) Consistency. Code must follow PEP8
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 abstra
c
tions.
4) Future Compatibility. Code must not be incompatible with the
long-term vision of either the codebase or of edX.
5) Somewhat documented
...
...
@@ -54,6 +56,6 @@ following standards:
Prototype
Prototype code should live in a sep
e
rate branch. It should strive
Prototype code should live in a sep
a
rate branch. It should strive
to follow PEP8, be readable, testable, and future-proof, but we have
no hard standards.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment