Skip to content

Commit

Permalink
First draft of CONTRIBUTING file
Browse files Browse the repository at this point in the history
Closes Issue MDAnalysis#508
  • Loading branch information
richardjgowers authored and backpropper committed Mar 13, 2016
1 parent d950a30 commit c0d42ad
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
15 changes: 15 additions & 0 deletions package/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Contributing to MDAnalysis

Thanks for contributing to MDAnalysis!

#### Reporting issues

If you've found a defect with MDAnalysis we'd love to know so we can fix it. Please follow the Issue template so we can quickly diagnose the problem, in particular the piece of code that causes the problem.

If your issue isn't a defect with the code and instead you require help using MDAnalysis, drop by the [discussion board](http://help.mdanalysis.org).

#### Contributing code

If you're contributing code, please check out the [Style guide](https://github.com/MDAnalysis/mdanalysis/wiki/Style-Guide).

MDAnalysis devs are most easily reached through the [development board](http://developers.mdanalysis.org).
19 changes: 19 additions & 0 deletions package/.github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Expected behaviour


### Actual behaviour


### Code to reproduce the behaviour

``` python
import MDAnalysis as mda

u = mda.Universe(top, trj)

....

```

### Currently version of MDAnalysis:
(run 'python -c "import MDAnalysis as mda; print(mda.__version__)"')
12 changes: 12 additions & 0 deletions package/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Fixes #

Changes made in this Pull Request:
-


PR Checklist
------------
- [ ] Tests?
- [ ] Docs?
- [ ] CHANGELOG updated?
- [ ] Issue raised/referenced?

0 comments on commit c0d42ad

Please sign in to comment.