Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 4.48 KB

Hi there, welcome to contributing guidelines for this project.

What do I need to know to help?

If you are interested in making a code contribution and would like to learn more about the technologies that this projects use, check out the list below.

A very detailed tutorial for this project is available on Dev.to

How do I make a contribution?

  1. Find an issue tagged that you are interested in addressing or a feature that you would like to add.

  2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/repository-name.

  3. Clone the repository to your local machine using git clone https://github.com/github-username/repository-name.git.

  4. Create a new branch for your fix using git checkout -b .

  5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.

  6. Use git add to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.

  7. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.

  8. Push the changes to the remote repository using git push origin branch-name-here.

  9. Submit a pull request to the upstream repository.

  10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added volume control feature to address #4352".

  11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!

  12. Wait for the pull request to be reviewed by a maintainer.

  13. Make changes to the pull request if the reviewing maintainer recommends them.

  14. Celebrate your success after your pull request is merged!

Where can I go for help?

If you need help, you can reach out to Srushtika on Twitter or open a support ticket at [email protected]

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

We love thorough bug reports! 💖

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Code of Conduct

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity.

If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately. Please reach out to Srushtika in case of any concerns.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft and Safia Abdalla's article on OpenSource.com