|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +😁 🎉 Thank you for taking the time to contribute! 😁 🎉 |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to this repo. |
| 6 | + |
| 7 | +- [Contributing Guidelines](#contributing-guidelines) |
| 8 | + - [Contributing](#contributing) |
| 9 | + - [Reporting Issues](#reporting-issues) |
| 10 | + - [Seeking Support](#seeking-support) |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Contributing |
| 15 | + |
| 16 | +To get started on contributing to this repo: |
| 17 | + |
| 18 | +- Follow [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) |
| 19 | +- Read these **Contributing Guidelines** to completion |
| 20 | +- Choose an existing feature/bug listed under GitHub issues for the repo. If the feature/bug is not listed under issues, |
| 21 | + create a new issue. |
| 22 | +- Fork and create a new branch for your work. |
| 23 | +- Submit a pull request with adequate documentation of functionality and changes made. Ensure the PR description clearly |
| 24 | +describes the problem and solution. Include the relevant issue number. |
| 25 | + |
| 26 | +## Reporting Issues |
| 27 | + |
| 28 | +If you encounter a bug while using the project, we want to hear about it! Here's how to report a bug: |
| 29 | + |
| 30 | + 1. Check the existing GitHub issues for the repo to see if the bug has already been reported. |
| 31 | + 2. If the bug has not already been reported, create a new issue by clicking the "New Issue" button on the GitHub |
| 32 | + issues for the repo and click "Get started" for a "🐞 Bug Report". |
| 33 | + 3. In the 🐞 Bug Report template, provide a clear and concise description of the bug, including any error messages |
| 34 | + that you encountered and steps to reproduce the bug in a specific environment. |
| 35 | + 4. If possible, include any relevant details such as the version of the project you are using, your operating system, |
| 36 | + and any other relevant information that may help to reproduce and fix the bug. |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +## Seeking Support |
| 41 | + |
| 42 | +For support in setting up and using this repo, please contact us via GitHub issues for the repo |
0 commit comments