Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 2.25 KB

Contributing Guide

Want to contribute to the this project? You're awesome! Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

This project follows the all-contributors specification.

Propose New Features or Report Bugs

Please open an issue to report bugs or to propose new features.

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! 😃

If you are reporting a bug, please include:

  • Your relevant system info.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Implement Features or Fix Bugs

Look through the GitHub issues for bugs and features. Anything tagged with bug, enhancement and help wanted is open to whoever wants to implement it. You rock!

Write Documentation

This project could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Proposing pull requests

Pull requests are very welcome. Note that if you are going to propose drastic changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.

Working on your first Pull Request?
You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

Get Started

Ready to contribute? Here's how to set up this project for local development.

  1. Fork this repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/project.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

  5. Submit a pull request through the GitHub website.