CONTRIBUTING.rst 2.78 KB
Newer Older
Derick Hess's avatar
Derick Hess committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.. highlight:: shell

============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://git.passcal.nmt.edu/passoft/h2e/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Derick Hess's avatar
Derick Hess committed
35
Look through the GitLab issues for features. Anything tagged with "enhancement"
Derick Hess's avatar
Derick Hess committed
36
37
38
39
40
41
42
43
44
45
46
47
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

h2e could always use more documentation, whether as part of the
official h2e docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

48
49
The best way to send feedback is to file an issue at
https://git.passcal.nmt.edu/passoft/h2e/issues.
Derick Hess's avatar
Derick Hess committed
50
51
52
53
54
55
56
57
58
59
60
61
62

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
  are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `h2e` for local development.

63
1. Clone the `h2e` repo:
Derick Hess's avatar
Derick Hess committed
64
65
66

    $ git clone https://git.passcal.nmt.edu/passoft/h2e.git

67
2. Install your local copy:
Derick Hess's avatar
Derick Hess committed
68

Derick Hess's avatar
Derick Hess committed
69
    $ pip install -e .[dev]
Derick Hess's avatar
Derick Hess committed
70

71
3. Create a branch for local development:
Derick Hess's avatar
Derick Hess committed
72
73
74
75
76

    $ git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

77
4. When you're done making changes, check that your changes pass the
78
   tests:
Derick Hess's avatar
Derick Hess committed
79
80

    $ python setup.py test
81
5. Commit your changes and push your branch to GitHub:
Derick Hess's avatar
Derick Hess committed
82
83
84
85
86

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature

87
6. Submit a merge request through the Gitlab website.
Derick Hess's avatar
Derick Hess committed
88
89
90
91

Pull Request Guidelines
-----------------------

Derick Hess's avatar
Derick Hess committed
92
Before you submit a merge request, check that it meets these guidelines:
Derick Hess's avatar
Derick Hess committed
93

Derick Hess's avatar
Derick Hess committed
94
95
1. The merge request should include tests.
2. If the merge request adds functionality, the docs should be updated. Put
Derick Hess's avatar
Derick Hess committed
96
97
   your new functionality into a function with a docstring, and add the
   feature to the list in README.rst.
98
3. The pull request should work for Python 3.[6,7,8]
Derick Hess's avatar
Derick Hess committed
99
100
101
102
103

Tips
----

To run a subset of tests::
104
    $ python -m unittest
Derick Hess's avatar
Derick Hess committed
105
106
107
108
109
110
111
112
113
114

Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ git push
$ git push --tags