Skip to content

Commit 1f14c58

Browse files
committed
added contributing guide to docs
1 parent 08c7b61 commit 1f14c58

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

docs/source/help.rst

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

443
Mailing list
544
------------
@@ -8,6 +47,3 @@ There is a public mailing list for discussing pyro. Visit the
847
`pyro-code@googlegroups.com
948
<https://groups.google.com/forum/#!forum/pyro-code>`_ and
1049
subscribe. You can then send questions to that list.
11-
12-
13-

0 commit comments

Comments
 (0)