31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# How to contribute
|
|
|
|
First off, thanks for taking the time to contribute! 🎉👍🎉👍🎉
|
|
|
|
The following is a set of guidelines for contributing this project.
|
|
These are mostly guidelines, not rules.
|
|
Use your best judgment, and feel free to propose changes to this document in a pull request.
|
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change.
|
|
|
|
<!--Note that we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.-->
|
|
|
|
### 🐞 You found a bug or have an issue?
|
|
|
|
1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](issues).
|
|
2. Create a [new issue](issues/new) with a **clear and descriptive title**
|
|
3. Write a **detailed comment** with as much relevant information as possible including
|
|
- *how to reproduce* the bug
|
|
- a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring
|
|
- any *files that could help* trace it down (i.e. logs)
|
|
|
|
### 🩹 You wrote a patch that fixes an issue?
|
|
|
|
1. Open a [new pull request (PR)](pulls) with the patch.
|
|
2. Ensure the PR description clearly describes the problem and solution.
|
|
3. Link the relevant **issue** if applicable ([how to link issues in PRs](https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls)).
|
|
4. Ensure that [**no tests are failing**](actions) and **coding conventions** are held
|
|
5. Submit the patch and await review.
|
|
|
|
### 🆕 You want to add a new feature?
|