Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
fslpy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container Registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Michiel Cottaar
fslpy
Commits
a2c59872
Commit
a2c59872
authored
7 years ago
by
Paul McCarthy
Browse files
Options
Downloads
Patches
Plain Diff
Fleshing out contribution guid
parent
cfd77ec9
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/contributing.rst
+80
-10
80 additions, 10 deletions
doc/contributing.rst
with
80 additions
and
10 deletions
doc/contributing.rst
+
80
−
10
View file @
a2c59872
Contributing to fslpy
Contributing to fslpy
=====================
=====================
TODO
Key points:
*This document is a work in progress*
- The master branch should always be stable and ready to release
- A separate branch is created for each release
Development model
-----------------
- Development occurs through a pull request (a.k.a. "merge request") model. All
changes to the master branch occur via merge requests.
-
Use semantic versioning, to allow for compatibilty testing:
-
The master branch should always be stable and ready to release. All
http://semver.org/
development occurs on the master branch.
- Unit tests are currently run with `py.test` and `coverage`. Aim for 100%
- All changes to the master branch occur via merge requests. Individual
code coverage.
developers are free to choose their own development workflow in their own
repositories.
- A separate branch is created for each release. Hotfixes may be added to
these release branches.
- Merge requests will not be accepted unless:
- All existing tests pass (or have been updated as needed).
- New tests have been written to cover newly added features.
- Code coverage is as close to 100% as possible.
- Coding conventions are adhered to (unless there is good reason not to).
Version number
--------------
The `fslpy` version number follows [semantic versioning](http://semver.org/)
rules, so that dependant projects are able to perform compatibility testing.
The version number comprises three numbers::
major.minor.patch
- The `patch` number is incremented on bugfixes and minor
(backwards-compatible) changes.
- The `minor` number is incremented on feature additions and major
backwards-compatible changes.
- The `major` number is incremented on backwards-incompatible changes.
Testing
-------
Unit and integration tests are currently run with `py.test` and `coverage`. We
don't have CI configured yet, so tests have to be run manually.
- Aim for 100% code coverage.
- Tests must pass on both python 2.7 and 3.5
- Tests must pass on both wxPython 3.0.2.0 and 4.0.0
Coding conventions
------------------
- Clean, readable code is good
- White space and visual alignment is good (where it helps to make the code
more readable)
- Clear and accurate documentation is good
Configure your text editor to use [pylint](https://www.pylint.org/) and
[flake8](http://flake8.pycqa.org/en/latest/).
The following violations of the PEP8 standard are accepted (see
[here](https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes)
for a list of error codes):
- E127: continuation line over-indented for visual indent
- E201: whitespace after '('
- E203: whitespace before ':'
- E221: multiple spaces before operator
- E222: multiple spaces after operator
- E241: multiple spaces after ','
- E271: multiple spaces after keyword
- E272: multiple spaces before keyword
- E301: expected 1 blank line, found 0
- E302: expected 2 blank lines, found 0
- E303: too many blank lines (3)
- E701: multiple statements on one line (colon)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment