Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 2.93 KB

CONTRIBUTING.rst

File metadata and controls

105 lines (70 loc) · 2.93 KB
Raw

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://github.com/MeteoSwiss/opendap-protocol/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

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

Write Documentation

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

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/MeteoSwiss/opendap-protocol/issues

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 opendap_protocol for local development.

  1. Clone opendap_protocol repo from GitHub.

    $ git clone [email protected]:MeteoSwiss/opendap-protocol.git

  2. Create a virtualenv and install dependencies:

    $ cd opendap_protocol
$ virtualenv venv
$ source venv/bin/activate
$ python setup.py develop

  3. Create a branch for local development:

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

    Now you can make your changes locally.

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

    $ python setup.py test
$ pylint opendap_protocol
$ tox

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

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

  6. 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 3.6 (or greater). Check https://github.com/MeteoSwiss/opendap-protocol/pulls and make sure that the tests pass for all supported Python versions.