|
| 1 | +# Contribution Guide |
| 2 | + |
| 3 | +First off, thanks for taking the time to contribute! ❤️ |
| 4 | + |
| 5 | +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 |
| 6 | + |
| 7 | +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: |
| 8 | +> - Star the project |
| 9 | +> - Tweet about it |
| 10 | +> - Refer this project in your project's readme |
| 11 | +> - Mention the project at local meetups and tell your friends/colleagues |
| 12 | +
|
| 13 | + |
| 14 | +## Table of Contents |
| 15 | + |
| 16 | +- [Code of Conduct](#code-of-conduct) |
| 17 | +- [I Have a Question](#i-have-a-question) |
| 18 | +- [I Want To Contribute](#i-want-to-contribute) |
| 19 | +- [Reporting Bugs](#reporting-bugs) |
| 20 | +- [Suggesting Enhancements](#suggesting-enhancements) |
| 21 | +- [Your First Code Contribution](#your-first-code-contribution) |
| 22 | +- [Improving The Documentation](#improving-the-documentation) |
| 23 | +- [Styleguides](#styleguides) |
| 24 | +- [Commit Messages](#commit-messages) |
| 25 | +- [Join The Project Team](#join-the-project-team) |
| 26 | + |
| 27 | + |
| 28 | +## Code of Conduct |
| 29 | + |
| 30 | +This project and everyone participating in it is governed by the |
| 31 | +[CONTRIBUTING.md Code of Conduct](blob/master/CODE_OF_CONDUCT.md). |
| 32 | +By participating, you are expected to uphold this code. Please report unacceptable behavior |
| 33 | +to <>. |
| 34 | + |
| 35 | + |
| 36 | +## I Have a Question |
| 37 | + |
| 38 | +Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. |
| 39 | + |
| 40 | +If you then still feel the need to ask a question and need clarification, we recommend the following: |
| 41 | + |
| 42 | +- Open an [Issue](/issues/new). |
| 43 | +- Provide as much context as you can about what you're running into. |
| 44 | +- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. |
| 45 | + |
| 46 | +We will then take care of the issue as soon as possible. |
| 47 | + |
| 48 | + |
| 49 | +## I Want To Contribute |
| 50 | + |
| 51 | +> ### Legal Notice |
| 52 | +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. |
| 53 | +
|
| 54 | +### Reporting Bugs |
| 55 | + |
| 56 | +#### How Do I Submit a Good Bug Report? |
| 57 | + |
| 58 | +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>. |
| 59 | +
|
| 60 | + |
| 61 | +We use GitHub issues to track bugs and errors. If you run into an issue with the project: |
| 62 | + |
| 63 | +- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) |
| 64 | +- Explain the behavior you would expect and the actual behavior. |
| 65 | +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. |
| 66 | +- Provide the information you collected in the previous section. |
| 67 | + |
| 68 | +Once it's filed: |
| 69 | + |
| 70 | +- The project team will label the issue accordingly. |
| 71 | +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. |
| 72 | +- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +#### How Do I Submit a Good Enhancement Suggestion? |
| 77 | + |
| 78 | +Enhancement suggestions are tracked as [GitHub issues](/issues). |
| 79 | + |
| 80 | +- Use a **clear and descriptive title** for the issue to identify the suggestion. |
| 81 | +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. |
| 82 | +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. |
| 83 | +- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. |
| 84 | +- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration. |
| 85 | + |
| 86 | + |
| 87 | +## Attribution |
| 88 | +This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)! |
0 commit comments