CONTRIBUTING.rst 3.31 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
.. 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
~~~~~~~~~~~

18
Report bugs at https://git.gfz-potsdam.de/geomultisens/gms_preprocessing/issues.
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

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
~~~~~~~~~~~~~~~~~~

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

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

41
42
gms_preprocessing could always use more documentation, whether as part of the
official gms_preprocessing docs, in docstrings, or even on the web in blog posts,
43
44
45
46
47
articles, and such.

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

48
The best way to send feedback is to file an issue at https://git.gfz-potsdam.de/geomultisens/gms_preprocessing/issues.
49
50
51
52
53
54
55
56
57
58
59

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!
------------

60
Ready to contribute? Here's how to set up `gms_preprocessing` for local development.
61

62
1. Fork the `gms_preprocessing` repo on GitHub.
63
64
2. Clone your fork locally::

65
    $ git clone https://git.gfz-potsdam.de/geomultisens/gms_preprocessing
66
67
68

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

69
70
    $ mkvirtualenv gms_preprocessing
    $ cd gms_preprocessing/
71
72
73
74
75
76
77
78
79
80
    $ python setup.py develop

4. Create a branch for local development::

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

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::

81
    $ flake8 gms_preprocessing tests
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
    $ python setup.py test or py.test
    $ tox

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::

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

7. Submit a pull request through the GitHub website.

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

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
   your new functionality into a function with a docstring, and add the
   feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
105
   https://travis-ci.org/geomultisens/gms_preprocessing/pull_requests
106
107
108
109
110
111
112
113
   and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::


114
    $ python -m unittest tests.test_gms_preprocessing