From e0e5897419abaf42c37d6e36602b5354e35c0efa Mon Sep 17 00:00:00 2001 From: Thomas Cokelaer Date: Tue, 29 Aug 2017 10:49:18 +0200 Subject: [PATCH] Create CONTRIBUTING.rst --- CONTRIBUTING.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..e389b57 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,33 @@ +================================== +Spectrum contributing guidelines +================================== + +Issues +========== + +You have an issue ? You found a bug ? Please submit an issue with + +- a description of the problem +- the version of Sequana used +- the error message if any + + +pull requests +=================== + +Pull requests are always welcome, and the Spectrum community appreciates +any help you may give. + +When submitting a pull request, we ask you to check the following: + +1. **Unit tests**, **documentation**, and **code style** are in order. + + It's also OK to submit work in progress if you're unsure of what + this exactly means, in which case you'll likely be asked to make + some further changes. + +2. The contributed code will be **licensed under spectrum's license** (BSD3), + If you did not write the code yourself, you ensure the existing + license is compatible and include the license information in the + contributed files, or obtain a permission from the original + author to relicense the contributed code.