Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kmichael08 committed Mar 7, 2019
1 parent 69bbdcb commit 51a6084
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Contribution
Great to see you here. Thank you for considering contribution to pyCeterisParibus. Let's make it better together!

### Reporting bugs
Have you found a bug?
* Make sure you have the **latest version** of the package.
* **Check whether it is not already in** [Issues](https://github.com/ModelOriented/pyCeterisParibus/issues).
* Add an issue following **Bug report template**.

### Fixing bugs
Do you know how to fix the bug? You are more than welcome to do this!
* Clone this repo.
* Fix the bug.
* Make sure all the **tests** passed.
* Open the pull request, attach the issue number in description if possible.

### Suggest a new feature
* Use **Feature request template**.

### Launching tests
Tests are launched automatically using travis.

You can also run them with ```python -m pytest --cov=./```

0 comments on commit 51a6084

Please sign in to comment.