|
| 1 | +# Contributing to Transcriptase |
| 2 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 3 | + |
| 4 | +- Reporting a bug |
| 5 | +- Discussing the current state of the code |
| 6 | +- Submitting a fix |
| 7 | +- Proposing new features |
| 8 | +- Becoming a maintainer |
| 9 | + |
| 10 | +## We Develop with Github |
| 11 | +We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| 12 | + |
| 13 | +## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests |
| 14 | +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests: |
| 15 | + |
| 16 | +1. Fork the repo and create your branch from `main`. |
| 17 | +2. If you've added code that should be tested, add tests. |
| 18 | +3. If you've changed the API, update the README.md and Storybook docs. |
| 19 | +4. Add the correct Github label to your PR (ex: documentation, enhancement, etc.) |
| 20 | +4. Ensure the test suite passes. |
| 21 | +5. Make sure your code lints. |
| 22 | +6. Issue that pull request! |
| 23 | + |
| 24 | +## Any contributions you make will be under the MIT Software License |
| 25 | +In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. |
| 26 | + |
| 27 | +## Report bugs using Github's [issues](https://github.com/asabaylus/react-command-palette/issues) |
| 28 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/asabaylus/react-command-palette/issues/new/choose); it's that easy! |
| 29 | + |
| 30 | +## Write bug reports with detail, background, and sample code |
| 31 | +The Bug template in GitHub makes this easy |
| 32 | + |
| 33 | +**Great Bug Reports** tend to have: |
| 34 | +* A desciption of the bug |
| 35 | +* Steps to reproduce |
| 36 | +* Expected behavior |
| 37 | +* Screenshots |
| 38 | +* Desktop / Smartphone details |
| 39 | + - Device: [e.g. iPhone6] |
| 40 | + - OS: [e.g. iOS8.1] |
| 41 | + - Browser [e.g. stock browser, safari] |
| 42 | + - Version [e.g. 22] |
| 43 | +* Additional context |
| 44 | + |
| 45 | + |
| 46 | +People *love* thorough bug reports. I'm not even kidding. |
| 47 | + |
| 48 | + |
| 49 | +## License |
| 50 | +By contributing, you agree that your contributions will be licensed under its MIT License. |
| 51 | + |
| 52 | +## References |
| 53 | +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md) |
0 commit comments