Skip to content

Latest commit

 

History

History
115 lines (77 loc) · 8.48 KB

CONTRIBUTING.md

File metadata and controls

115 lines (77 loc) · 8.48 KB

Contributing Guide Contributor Convenant v2.0 Code of Conduct Apache 2.0 license

Want to contribute to this project? Wow, you're the best! 😍 Every little bit helps, and since this project follows the all-contributors specification credit will always be given. ✨

Note: This project is released with a respect-oriented Contributor Code of Conduct, based on the Contributor Covenant. By participating in this project you agree to abide by its fair terms.

You can contribute in many ways:

Types of Contributions All Contributors Issues queue

Report Bugs

If you are reporting a bug, please open an issue and include:

  • A description of the bug.
  • Detailed steps to reproduce the bug, unless the issue is obvious.
  • Any details about your local setup that might be helpful in troubleshooting.

Submit Feedback or Propose New Features

If you have an idea to share, please open an issue:

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

Fix Bugs or Implement Features

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

Share With the World Tweet

Projects that are unpopular end up all sad and alone. 😿 Help this one thrive by talking to the world about its glorious existence in blog posts, forums threads, social media, article, anywhere you may see fit! We love you! 😍

Get Started! Fork me on GitHub Conventional Commits v1.0.0

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, ideally using Conventional Commits comment style, and push your branch to GitHub:

    git add .
git commit -m "type(scope): active voice summary of changes"
git push origin name-of-your-bugfix-or-feature

  5. Submit a pull request through GitHub.

Proposing Pull Requests 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 the free online course How to Contribute to an Open Source Project.

😃 Yay! 🎈