Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
T
topydo
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
topydo
Commits
f6a80405
Commit
f6a80405
authored
Nov 10, 2015
by
Bram Schoenmakers
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update CONTRIBUTING.md
parent
be6a1965
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
14 deletions
+16
-14
CONTRIBUTING.md
CONTRIBUTING.md
+16
-14
No files found.
CONTRIBUTING.md
View file @
f6a80405
...
@@ -15,36 +15,38 @@ smoothly into topydo.
...
@@ -15,36 +15,38 @@ smoothly into topydo.
possible. I won't be very picky about long lines, but please try to avoid
possible. I won't be very picky about long lines, but please try to avoid
them.
them.
*
I strongly prefer simple and short functions, doing only one thing. I'll
*
I strongly prefer simple and short functions, doing only one thing. I'll
request
you to refactor functions with massive indentation or don't fit
ask
you to refactor functions with massive indentation or don't fit
otherwise on a screen.
otherwise on a screen.
### Testing
### Testing
*
Run tests with
:
*
First make sure to have the prerequisites installed to perform the tests
:
green
pip install .[test]
*
Then, run the tests with:
green -r
Obviously, I won't accept anything that makes the tests fail. When you submit
Obviously, I won't accept anything that makes the tests fail. When you submit
a Pull Request, Travis CI will automatically run all tests for various Python
a Pull Request, Travis CI will automatically run all tests for various Python
versions, but it's better if you run the tests locally first.
versions, but it's better if you run the tests locally first.
Make sure you have the
`mock`
package installed if you test on a Python
version older than 3.3.
*
Add tests for your change(s):
*
Add tests for your change(s):
*
Bugfixes: add a testcase that covers your bugfix, so the bug won't happen
*
Bugfixes: add a test
case that covers your bugfix, so the bug won't happen
ever again.
ever again.
*
Features: add testcases that checks various inputs and outputs of your
*
Features: add test
cases that checks various inputs and outputs of your
feature. Be creative in trying to break the feature you've just implemented.
feature. Be creative in trying to break the feature you've just implemented.
*
Check the test coverage of your contributed code, in particular if you
*
Check the test coverage of your contributed code, in particular if you
touched
touched
code in the topydo.lib or topydo.command packages:
code in the topydo.lib or topydo.command packages:
pip install coverage
coverage report -m
coverage run setup.py test
coverage report
Or alternatively, for a more friendly output, run:
Or alternatively, for a more friendly output, run:
coverage html
coverage html
W
hich will generate annotated files in the
*htmlcov*
folder. The new code
w
hich will generate annotated files in the
*htmlcov*
folder. The new code
should be marked green (i.e. covered).
should be marked green (i.e. covered).
When you create a Pull Request, code coverage will be automatically checked
and reported by
[
Codecov.io
](
https://codecov.io/github/bram85/topydo
)
.
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