diff --git a/README.md b/README.md index dc39a71add933f74384e08aad914382507703696..a63ac35a54eebcad5f8603229aaa6fe2197ad6fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ fslpy ===== + The `fslpy` project is a [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/) programming library written in Python. It is used by [FSLeyes](https://git.fmrib.ox.ac.uk/paulmc/fsleyes/). @@ -27,6 +28,10 @@ running: 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 ----- diff --git a/doc/contributing.rst b/doc/contributing.rst new file mode 100644 index 0000000000000000000000000000000000000000..3621c459db8f67e49d3658f8f8e341c8962a4554 --- /dev/null +++ b/doc/contributing.rst @@ -0,0 +1,19 @@ +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. diff --git a/doc/index.rst b/doc/index.rst index 2c342156a451d310dc244032180459b172633ea1..56e437af5d17f1b9443c9719e4b2af17a638b68e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,3 +11,4 @@ by |fsleyes_apidoc|_. self fsl + contributing