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
280bb96c
Commit
280bb96c
authored
Apr 30, 2014
by
David Baumgold
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
wordsmithing
parent
82f98b29
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
5 additions
and
5 deletions
+5
-5
CONTRIBUTING.rst
+2
-2
docs/en_us/developers/source/testing/code-coverage.rst
+1
-1
docs/en_us/developers/source/testing/code-quality.rst
+2
-2
No files found.
CONTRIBUTING.rst
View file @
280bb96c
...
...
@@ -11,9 +11,9 @@ but here's a step-by-step guide that should help you get started.
Step 0: Join the Conversation
=============================
Got an idea for how to improve the codebase? Fantastic
;
we'd love to hear about
Got an idea for how to improve the codebase? Fantastic
,
we'd love to hear about
it! Before you dive in and spend a lot of time and effort making a pull request,
it's a good idea to discuss your idea with other interested developers
; y
ou may
it's a good idea to discuss your idea with other interested developers
. Y
ou may
get some valuable feedback that changes how you think about your idea, or you
may find other developers who have the same idea and want to work together.
...
...
docs/en_us/developers/source/testing/code-coverage.rst
View file @
280bb96c
...
...
@@ -5,7 +5,7 @@ Code Coverage
We measure which lines of our codebase are covered by unit tests using
`coverage.py`_ for Python and `JSCover`_ for Javascript.
Our codebase is far from perfect, but the goal is to s
low
ly improve our coverage
Our codebase is far from perfect, but the goal is to s
teadi
ly improve our coverage
over time. To do this, we wrote a tool called `diff-cover`_ that will
report which lines in your branch are not covered by tests, while ignoring
other lines in the project that may not be covered. Using this tool,
...
...
docs/en_us/developers/source/testing/code-quality.rst
View file @
280bb96c
...
...
@@ -2,13 +2,13 @@
Code Quality
************
In order to keep our code
base
as clear and readable as possible, we use various
In order to keep our code as clear and readable as possible, we use various
tools to assess the quality of pull requests:
* We use the `pep8`_ tool to follow `PEP-8`_ guidelines
* We use `pylint`_ for static analysis and uncovering trouble spots in our code
Our codebase is far from perfect, but the goal is to s
low
ly improve our quality
Our codebase is far from perfect, but the goal is to s
teadi
ly improve our quality
over time. To do this, we wrote a tool called `diff-quality`_ that will
only report on the quality violations on lines that have changed in a
pull request. Using this tool, we can ensure that pull requests do not introduce
...
...
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