From a9d6732102be9e697788016ada6e3d1200ca216d Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Tue, 25 Apr 2017 11:32:28 +0100
Subject: [PATCH] Add link to (unwritten) contributing guide
---
README.md | 5 +++++
doc/contributing.rst | 19 +++++++++++++++++++
doc/index.rst | 1 +
3 files changed, 25 insertions(+)
create mode 100644 doc/contributing.rst
diff --git a/README.md b/README.md
index dc39a71ad..a63ac35a5 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 000000000..3621c459d
--- /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 2c342156a..56e437af5 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -11,3 +11,4 @@ by |fsleyes_apidoc|_.
self
fsl
+ contributing
--
GitLab