Skip to content

Commit e0e5897

Browse files
authored
Create CONTRIBUTING.rst
1 parent 9c664c4 commit e0e5897

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
==================================
2+
Spectrum contributing guidelines
3+
==================================
4+
5+
Issues
6+
==========
7+
8+
You have an issue ? You found a bug ? Please submit an issue with
9+
10+
- a description of the problem
11+
- the version of Sequana used
12+
- the error message if any
13+
14+
15+
pull requests
16+
===================
17+
18+
Pull requests are always welcome, and the Spectrum community appreciates
19+
any help you may give.
20+
21+
When submitting a pull request, we ask you to check the following:
22+
23+
1. **Unit tests**, **documentation**, and **code style** are in order.
24+
25+
It's also OK to submit work in progress if you're unsure of what
26+
this exactly means, in which case you'll likely be asked to make
27+
some further changes.
28+
29+
2. The contributed code will be **licensed under spectrum's license** (BSD3),
30+
If you did not write the code yourself, you ensure the existing
31+
license is compatible and include the license information in the
32+
contributed files, or obtain a permission from the original
33+
author to relicense the contributed code.

0 commit comments

Comments
 (0)