Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.63 KB

CONTRIBUTING.rst

File metadata and controls

73 lines (46 loc) · 1.63 KB
Raw

Contributing

Contributions are welcome and appreciated! Credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/sbraden/circle-craters/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • QGIS version
  • Any details about your local setup that might be helpful.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs.

Implement Features

Look through the GitHub issues for features.

Write Documentation

CircleCraters could use more documentation.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/sbraden/circle-craters/issues.

Get Started!

Ready to contribute? Here's how to set up circle-craters for local development.

  1. Fork the circle-craters repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/circle-craters.git

  3. Create a branch for local development:

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

    Now you can make your changes locally.

  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
  1. 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. The pull request should work for Python 2.7.