Skip to content
This repository was archived by the owner on Jun 2, 2022. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
executable file
·
52 lines (37 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
52 lines (37 loc) · 1.46 KB
Raw

Contributing

We love your input!

Issues

Issues are very valuable for any project.

Great bug reports tend to have:

  • A quick summary and/or background.
  • Steps to reproduce.
  • Be specific.
  • Give sample code if you can.
  • What you expected would happen.
  • What actually happens.
  • Notes; why you think this might be happening, tests that didn't work...

Discussions

Discussions are essential:

  • General: anything that is relevant to the project.
  • Ideas: ideas to change/improve the project or propose new features.
  • Polls: polls with multi options for the community to vote for and discuss.
  • Q&A: questions for the community to answer, in a question/answer format.
  • Show and tell: creations, experiments, or tests relevant to the project.

Pull Requests

Pull requests are a great way to put your ideas into this project or simply fix something.

We actively welcome your pull requests:

  1. Fork the repository to your own Github account.
  2. Clone the project to your machine.
  3. Create a branch locally with a succinct but descriptive name.
  4. Commit changes to the branch.
  5. Following any formatting and testing guidelines specific to this repository.
  6. Push changes to your fork.
  7. Open a pull request in our repository and follow the pull request template so that we can efficiently review the changes.