Skip to content

Latest commit

 

History

History
123 lines (80 loc) · 3.56 KB

CONTRIBUTING.rst

File metadata and controls

123 lines (80 loc) · 3.56 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/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}/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

{{ cookiecutter.project_name }} could always use more documentation, whether as part of the official {{ cookiecutter.project_name }} 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/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}/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 {{ cookiecutter.project_repo }} for local development.

  1. Fork the {{ cookiecutter.project_repo }} repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/{{ cookiecutter.project_repo }}.git

  3. Install your local copy into a conda environment. Assuming you have conda installed, this is how you set up your fork for local development:

    $ cd {{ cookiecutter.project_repo }}/
$ make init
$ conda activate {{ cookiecutter.project_repo }}-dev

  4. Create a branch for local development, use the f-, i- or chore- prefixes to auto-label your PR:

    $ git checkout -b (f|i|chore)-name-of-your-contribution

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass black, flake8 and coverage tests:

    $ make format lint test

    All the dependencies should already be included in your conda environment.

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

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin (f|i|chore)-name-of-your-contribution

  7. 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 pass all our GitHub tests.

Tips

To run a subset of tests:

$ pytest tests.test_{{ cookiecutter.project_slug }}

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:

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

Travis will then deploy to PyPI if tests pass.