Skip to content

Commit 7ba810d

Browse files
committed
add a contributing file, based on pynucastrot
1 parent 02ff87e commit 7ba810d

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
Contributions are welcomed from anyone, including posting issues or
4+
submitting pull requests to the [pyro github](https://github.com/zingale/pyro).
5+
6+
## Issues
7+
8+
Creating an issue on github is a good way to request new features,
9+
file a bug report, or notify us of any difficulties that arise using
10+
pyro.
11+
12+
To request support using pyro, please create an issue on the pyro
13+
github and the developers will be happy to assist you.
14+
15+
If you are reporting a bug, please indicate any information necessary
16+
to reproduce the bug including your version of python.
17+
18+
## Pull Requests
19+
20+
*Any contributions that have the potential to change answers should be
21+
done via pull requests.* A pull request should be generated from your
22+
fork of pyro and target the `master` branch.
23+
24+
The unit and regression tests will run automatically once the PR is
25+
submitted, and then one of the pyro developers will review the PR and
26+
if needed, suggest modifications prior to merging the PR.
27+
28+
If there are a number of small commits making up the PR, we may wish
29+
to squash commits upon merge to have a clean history. *Please ensure
30+
that your PR title and first post are descriptive, since these will be
31+
used for a squashed commit message.*

0 commit comments

Comments
 (0)