Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 2.24 KB

CONTRIBUTING.rst

File metadata and controls

87 lines (55 loc) · 2.24 KB
Raw

Contributing

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/ajhynes7/scikit-spatial/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.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/ajhynes7/scikit-spatial/issues.

Get Started!

Ready to contribute? Here's how to set up scikit-spatial for local development.

  1. Fork the scikit-spatial repo on GitHub.

  2. Create a branch for local development:

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

    Now you can make your changes locally.

  3. When you're done making changes, check that your changes pass linting and tests. See .travis.yml for test commands.

  4. 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

  5. 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.
  3. Check https://travis-ci.org/ajhynes7/scikit-spatial/pull_requests and make sure that the tests pass for all supported Python versions.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.