-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1035445
commit c3d2e6d
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Contributing | ||
|
||
First off, thank you for considering contributing to this project. | ||
|
||
## Reporting Issues | ||
|
||
Before submitting an issue, please check the issue tracker to ensure that the issue hasn't already been reported. If you find your issue already reported, you can subscribe to that issue to receive updates. If you have any additional information to add, please comment on the issue. If the issue is unnasigned and you'd like to contribute, assign the issue to yourself. | ||
|
||
## How to Contribute | ||
|
||
If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question. | ||
|
||
If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following: | ||
|
||
- If your contribution is minor, such as a typo fix, open a pull request. | ||
- If your contribution is major, or you have not yet decided how to implement your idea, open an issue to discuss it. This allows other contributors to point out any potential flaws or to help you flesh out your idea. | ||
|
||
### Pull Requests | ||
|
||
1. Fork the repository and create your branch from `main`. | ||
2. Write some code | ||
3. Make sure your code lints. | ||
4. Issue that pull request! | ||
|
||
### Commit Messages | ||
|
||
Write meaningful commit messages that provide insight into the changes made. | ||
|
||
## Finding Bugs | ||
|
||
If you find a bug, please report it in the issue tracker with a detailed description. | ||
|
||
## Feature Requests | ||
|
||
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible. | ||
|
||
## License | ||
|
||
By contributing to this project, you agree that your contributions will be licensed under MIT. | ||
|
||
## Acknowledgments | ||
|
||
Your contributions are sincerely appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
|
||
Thank you for your interest in contributing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters