Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 4.34 KB

CONTRIBUTING.md

File metadata and controls

99 lines (72 loc) · 4.34 KB
Raw

Contributing

Introduction

First off, thank you for considering contributing to MetPy. MetPy is community-driven project, so it's people like you that make MetPy useful and successful.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

We love contributions from community members, just like you! There are many ways to contribute, from writing tutorial or example Jupyter notebooks, improvements to the documentation, submitting bug report and feature requests, or even writing code which can be incorporated into MetPy for everyone to use. If you get stuck at any point you can create an issue on GitHub or contact us at one of the other channels mentioned below.

For more information on contributing to open source projects, GitHub's own guide is a great starting point.

Ground Rules

The goal is to maintain a diverse community that's pleasant for everyone. Please be considerate and respectful of others. Other items:

  • Each pull request should consist of a logical collection of changes. You can include multiple bug fixes in a single pull request, but they should be related. For unrelated changes, please submit multiple pull requests.
  • Do not commit changes to files that are irrelevant to your feature or bugfix (eg: .gitignore).
  • Be willing to accept criticism and work on improving your code; we don't want to break other users' code, so care must be taken not to introduce bugs.
  • Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.

Reporting a bug

When creating a new issue, please be as specific as possible. Include the version of the code you were using, as well as what operating system you are running. If possible, include complete, minimal example code that reproduces the problem.

Pull Requests

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

We love pull requests from everyone. Fork, then clone the repo:

git clone [email protected]:your-username/metpy.git

Install metpy:

pip install .

Install py.test and make sure the tests pass:

pip install pytest
py.test

Make your change. Add tests for your change. Make the tests pass:

py.test

Commit the changes you made. Chris Beams has written a guide on how to write good commit messages.

Push to your fork and submit a pull request.

For the Pull Request to be accepted, you need to agree to the MetPy Contributor License Agreement (CLA). See here for more explanation and rationale behind MetPy's CLA.

As part of the Pull Request, be sure to add yourself to the list of contributors. We want to make sure we acknowledge the hard work you've generously contributed here.

Code Review

Once you've submitted a Pull Request, at this point you're waiting on us. You should expect to hear at least a comment within a couple of days. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

Pull requests will automatically have tests run by Travis. This includes running both the unit tests as well as the flake8 code linter.

Other Channels

If you're interested in contacting us or being a part of the community in other ways, feel free to contact us in MetPy's Gitter Channel or through Unidata's python-users mailing list.