-
Notifications
You must be signed in to change notification settings - Fork 5
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
Showing
1 changed file
with
34 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,34 @@ | ||
# Contributing to Green-Labs/Garter | ||
First off, thank you for considering contributing to Garter. | ||
|
||
## Ways to Contribute | ||
There are many ways to contribute to Garter, from improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Garter itself. | ||
|
||
### Reporting Bugs | ||
Before submitting bug reports, please check the existing reported issues to make sure it hasn't already been reported. | ||
Be as detailed as possible in your report. | ||
|
||
### Feature Requests | ||
For feature requests, check the issues to see if it has already been suggested. | ||
Provide a clear and detailed explanation of the feature you would like to see, and why it would be useful. | ||
|
||
### Code Contributions | ||
If you would like to contribute code, start by searching through the issues for projects you can tackle. | ||
Fork the repository and make your changes. | ||
Submit a pull request with a clear description of your changes. | ||
|
||
### Getting Started | ||
1. Fork the repository on GitHub. | ||
2. Clone your fork to your local machine. | ||
3. Create a new branch for your changes. | ||
4. Make sure your code adheres to the existing coding conventions. | ||
5. Write tests for your changes. | ||
6. Update changelog using changset | ||
```sh | ||
pnpm changeset | ||
``` | ||
Pick one of `patch` | `minor` | `major` and write short summary of your changes and commit. | ||
|
||
7. Submit a pull request to the main branch. | ||
|
||
Thank you for your interest in contributing to Garter. We look forward to your contributions! |