Skip to content

Latest commit

 

History

History
executable file
·
70 lines (42 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
70 lines (42 loc) · 2.19 KB
Raw

Contributing

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

Types of Contributions

Report Bugs

Report bugs at https://github.com/py-pkgs/py-pkgs-cookiecutter/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

py-pkgs-cookiecutter could always use more documentation!

Submit Feedback

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

Get Started!

Ready to contribute? Here's how to set up py-pkgs-cookiecutter for local development.

  1. Fork the py-pkgs-cookiecutter repo on GitHub.

  2. Clone your fork locally::

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

  3. Create a branch for local development and make your changes locally::

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

  4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.

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

  6. Submit a pull request on GitHub.

Code of Conduct

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