-
Notifications
You must be signed in to change notification settings - Fork 0
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
0c9a04b
commit 0a736c9
Showing
1 changed file
with
29 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,29 @@ | ||
# Contributing Guidelines | ||
|
||
Thanks you so much for your interest in contributing to this project! | ||
|
||
## About our deal | ||
|
||
Hi! I'm Rehan and i'm the creator and maintainer of this project. | ||
|
||
If you encounter bugs, please **do** open an issue describing the bug and including steps to easily reproduce it (bonus points for a CodeSandbox that demonstrates the problem). | ||
|
||
If you have an idea for an enhancement, go ahead and share it via an issue, but please don't expect a timely response. | ||
|
||
This project is MIT-licensed, and this means that you can implement and use whatever enhancements you'd like. | ||
|
||
## Commits and Code Padronization | ||
|
||
This project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. [Husky](https://github.com/typicode/husky) execute scrips according to git hooks in order to test if a developer is following the Eslint Lint Rules and also the commits convention. | ||
|
||
## Bug reports | ||
|
||
If you encounter a problem with this project, please open an issue. Be sure to include: | ||
|
||
- Package version | ||
- Node and Express versions | ||
- Brief but thorough description of the issue | ||
- Link to a CodeSandbox (or similar) demonstrating the problem (optional, but highly recommended, especially for complex problems) | ||
|
||
### Credit | ||
[Laura Beatris](https://github.com/LauraBeatris/gofinances-api/blob/master/CONTRIBUTING.md) for the Contributing Guidelines |