Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
fslpy
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Analyze
Contributor analytics
CI/CD 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
Evan Edmond
fslpy
Commits
a9d67321
Commit
a9d67321
authored
7 years ago
by
Paul McCarthy
Browse files
Options
Downloads
Patches
Plain Diff
Add link to (unwritten) contributing guide
parent
7b4165a1
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+5
-0
5 additions, 0 deletions
README.md
doc/contributing.rst
+19
-0
19 additions, 0 deletions
doc/contributing.rst
doc/index.rst
+1
-0
1 addition, 0 deletions
doc/index.rst
with
25 additions
and
0 deletions
README.md
+
5
−
0
View file @
a9d67321
fslpy
fslpy
=====
=====
The
`fslpy`
project is a
[
FSL
](
http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/
)
The
`fslpy`
project is a
[
FSL
](
http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/
)
programming library written in Python. It is used by
programming library written in Python. It is used by
[
FSLeyes
](
https://git.fmrib.ox.ac.uk/paulmc/fsleyes/
)
.
[
FSLeyes
](
https://git.fmrib.ox.ac.uk/paulmc/fsleyes/
)
.
...
@@ -27,6 +28,10 @@ running:
...
@@ -27,6 +28,10 @@ running:
The HTML documentation will be generated and saved in the
`doc/html/`
directory.
The HTML documentation will be generated and saved in the
`doc/html/`
directory.
If you are interested in contributing to
`fslpy`
, check out the
[
contributing
guide
](
doc/contributing.rst
)
.
Tests
Tests
-----
-----
...
...
This diff is collapsed.
Click to expand it.
doc/contributing.rst
0 → 100644
+
19
−
0
View file @
a9d67321
Contributing to fslpy
=====================
TODO
Key points:
- The master branch should always be stable and ready to release
- A separate branch is created for each release
- 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:
http://semver.org/
- Unit tests are currently run with `py.test` and `coverage`. Aim for 100%
code coverage.
This diff is collapsed.
Click to expand it.
doc/index.rst
+
1
−
0
View file @
a9d67321
...
@@ -11,3 +11,4 @@ by |fsleyes_apidoc|_.
...
@@ -11,3 +11,4 @@ by |fsleyes_apidoc|_.
self
self
fsl
fsl
contributing
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