|
| 1 | +# Contributor Guidelines |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +Welcome to the Strangelove contributor guidelines. We are excited to have you here and look forward to your contributions! |
| 6 | +Contributors are expected to adhere to the guidelines outlined in this document as well as our [code of conduct](./CODE_OF_CONDUCT.md). |
| 7 | + |
| 8 | +## Contributing |
| 9 | + |
| 10 | +There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, |
| 11 | +submitting bug reports and feature requests, or writing code which can be incorporated into the project itself. |
| 12 | + |
| 13 | +### Bug Reports |
| 14 | + |
| 15 | +First thing to note is that if you believe you have discovered a security vulnerability *DO NOT* use the public issue tracker. |
| 16 | +Please read our [security policy](./SECURITY.md) for more information on reporting security vulnerabilities. |
| 17 | + |
| 18 | +When creating a bug report, please use the [template](./.github/ISSUE_TEMPLATE/bug_report.yml) and include as much |
| 19 | +detail as possible. At a minimum be sure to include the following: |
| 20 | +- What you were trying to do |
| 21 | +- How the bug can be reproduced |
| 22 | +- What you expected to happen |
| 23 | +- What version of the software you were using |
| 24 | + |
| 25 | +### Feature Requests & Enhancements |
| 26 | + |
| 27 | +Feature requests and other enhancements can be made using the [template](./.github/ISSUE_TEMPLATE/feature_request.yml) provided. |
| 28 | +Please provide as much detail as possible, including the problem you are trying to solve and the solution you would like to see, |
| 29 | +along with possible alternatives you have considered if applicable. Understanding the use cases and the benefits the new feature |
| 30 | +or enhancement would bring to users helps the team to prioritize and implement the feature. |
| 31 | + |
| 32 | +### Doc Changes |
| 33 | + |
| 34 | +Documentation changes are always welcome. If you see a typo, or would like to improve the documentation in any way feel |
| 35 | +free to open a PR. If you are unsure about the changes you would like to make or if the changes go well beyond |
| 36 | +addressing simple grammar mistakes or formatting, open an issue to discuss the changes before opening a PR. |
| 37 | + |
| 38 | +### Opening PRs |
| 39 | + |
| 40 | +When opening new PRs it is advised to open an issue first to discuss the changes you would like to make. |
| 41 | +This helps to ensure that the changes are in line with the project goals and that the team is aware of the changes being made |
| 42 | +so that duplicate efforts are not made and everyone's time is used efficiently. |
| 43 | + |
| 44 | +When opening a PR, please ensure that the PR description includes the issue number that the PR is addressing. |
| 45 | +This helps to ensure that the PR is linked to the issue and that the issue is closed when the PR is merged. |
| 46 | + |
| 47 | + |
| 48 | +### Contributor License Agreement |
| 49 | + |
| 50 | +Before opening a PR, please review LICENSE.md and familiarize yourself with its terms. |
| 51 | +Please be advised that by opening a PR, you are granting Strangelove (or the owner of the relevant repository) a perpetual, |
| 52 | +worldwide, non-exclusive, no-charge, royalty-free, irrevocable license, in copyright and in patent, with respect to your |
| 53 | +Contribution and any portion thereof. |
0 commit comments