CONTRIBUTING.md

How to contribute (wip)

This document aims to give an overview of how to contribute to ObsPy. It tries to answer commonly asked questions, and provide some insight into how the community process works in practice.

Getting Started

• Make sure you have a GitHub account
• Download and install git
• Read the git documentation

Git workflow

We love pull requests! Here's a quick guide:

1. Fork the repo.
2. Make a new branch. For feature additions/changes base your new branch at "master", for pure bugfixes base your new branch at "releases" (see branching model).
3. Run the tests. We only take pull requests with passing tests.
4. 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!
5. Make the test pass.
6. Push to your fork and submit a pull request.
   • for feature branches set base branch to "obspy:master"
   • for bugfix branches set base branch to "obspy:releases"
7. Wait for our review. We may suggest some changes or improvements or alternatives.

Additional Resources

• Style Guide
• Docs or it doesn't exist!
• Performance Tips:
  • Python
  • NumPy and ctypes
  • SciPy
  • NumPy Book
• Interesting reading on git, github