Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

If you are reporting a bug, please include:

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

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

pyio-cookiecutter could always use more documentation!

The best way to send feedback is to file an issue at https://github.com/beam-pyio/pyio-cookiecutter/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 :)

Ready to contribute? Here’s how to set up pyio-cookiecutter for local development.

Clone your fork locally::

$ git clone git@github.com:your_name_here/pyio-cookiecutter.git

Create a branch for local development and make your changes locally::
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.

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

Please note that this project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.