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
cb24bc40
Commit
cb24bc40
authored
May 19, 2015
by
Bram Schoenmakers
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Create CONTRIBUTING.md
parent
ca10dd93
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
27 additions
and
0 deletions
+27
-0
CONTRIBUTING.md
CONTRIBUTING.md
+27
-0
No files found.
CONTRIBUTING.md
0 → 100644
View file @
cb24bc40
If you're reading this, you may have interest in enhancing topydo. Thank you!
Please read the following guidelines to get your enhancement / bug fixes smoothly into topydo:
*
This Github page defaults to the
**stable**
branch which is for
**bug fixes only**
. If you would like to add a new
feature, make sure to make a Pull Request on the
`master`
branch.
*
Run tests with:
python2 setup.py test
python3 setup.py test
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 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):
*
Bugfixes: add a testcase that covers your bugfix, so the bug won't happen ever again.
*
Features: add testcases that checks various inputs and outputs of your feature. Be creative in trying to break the
feature you've just implemented.
*
Use descriptive commit messages.
### Coding style
*
Please try to adhere to the coding style dictated by
`pylint`
as much possible. I won't be very picky about long lines,
but please try to avoid them.
*
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 otherwise on a screen.
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