Contributing to ObsPy
This document aims to give an overview of how to contribute to ObsPy. It tries to answer commonly asked questions, and to provide some insight into how the community process works in practice.
- To report a suspected bug or propose a feature addition, please open a new issue (please read and address what is pointed out in the issue template)
- To directly propose changes, a bug fix or to add a new feature, please open a pull request (please read the information on this page and also check the points mentioned in our pull request template)
- If you have questions that you want ask before opening an issue/pull request on Github, you can contact a developer..
- Make sure you have a GitHub account
- Download and install git
- Read the git documentation
- Install a development version of ObsPy
Submitting a Pull Request
We love pull requests! Here's a quick guide:
First, if the pull request (PR) is directly related to an already existing issue (which is no PR yet), drop us a note in that issue before opening the PR. We can convert existing issues into a PR, which avoids duplicated tickets. Otherwise, please follow the ObsPy branching model. If it is unclear what base branch is appropriate for your code changes, please contact us on gitter, the users mailing list or by opening an issue to discuss the PR first.
- Fork the repo.
- Make a new branch. For feature additions/changes base your new branch at
master, for pure bugfixes base your new branch at e.g.
- Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
- Make the test pass (call
obspy-runtestsor run individual tests using e.g. pytest)
- Push to your fork and submit a pull request.
- for feature branches set base branch to
- for bugfix branches set base branch to the latests maintenance branch, e.g.
- for feature branches set base branch to
- Wait for our review. We may suggest some changes or improvements or alternatives. Keep in mind that PR checklist items can be met after the pull request has been opened by adding more commits to the branch.
Please make sure to select the correct base branch (
maintenance_x.x.x) for your PR. If in doubt, ask us which one is appropriate first.
If your PR is adding a new submodule, please go through the to-do items for new submodules in the wiki.
If you want to request an automated build of ObsPy's API docs for your PR, simply include the magic string
+DOCS somewhere in the PR's comments. Once finished, the docs build will show up in the PR's review/commit status section alongside the results from Continuous Integration (PR docs builds can be looked up here).
If any specific networking modules should be tested for the PR, e.g. when proposing changes to the FDSN client module, please include a magic string like e.g.
+TESTS:clients.fdsn somewhere in the PR's comments. Multiple modules can be comma separated (e.g.
+TESTS:clients.fdsn,clients.iris) or put in separate
+TESTS:... strings, which will be accumulated across all of the PR's comments. To run all modules' test suites, include
+TESTS:ALL somewhere in a comment.
All the submitted pieces including potential data must be compatible with the LGPLv3 license and will be LGPLv3 licensed as soon as they are part of ObsPy. Sending a pull request implies that you agree with this.
Additionally take care to not add big files. Even for tests we generally only accept files that are very small and at max on the order of a few kilobytes. When in doubt.. ask us in the PR.
Submitting an Issue
If you want to ask a question about a specific ObsPy aspect, please first of all..
- search through Github issues tagged as "question" (you can add more search terms in the search box, e.g. search for Mini SEED related questions with additional search term "mseed")
- search the [obspy-users] mailing list archives, e.g. searching for term "mseed" via Google with search string "mseed site:http://lists.swapbytes.de/archives/obspy-users/"
If you want to post a problem/bug, to help us understand and resolve your issue please check that you have provided the information below:
- ObsPy version, Python version and Platform (Windows, OSX, Linux ...)
- How did you install ObsPy and Python (pip, anaconda, from source ...)
- If possible please supply a Short, Self Contained, Correct, Example that demonstrates the issue i.e a small piece of code which reproduces the issue and can be run with out any other (or as few as possible) external dependencies.
- If this is a regression (Used to work in an earlier version of ObsPy), please note when it used to work.
You can also do a quick check whether..
the bug was already fixed in the current maintenance branch for the next bug fix release, e.g. for the
1.0.xmaintenance line check the..
- corresponding changelog section "1.0.x:" right at the top which contains bug fixes that will be in the next release) or..
if it was already reported and/or is maybe even being worked on already by checking open issues of the corresponding milestone, e.g. see