-
-
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.
docs: 📝 contributing instructions added
- Loading branch information
1 parent
4451739
commit 585cb38
Showing
2 changed files
with
27 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,23 @@ | ||
# Contributing | ||
|
||
Firstly, thank you for considering to contribute. | ||
|
||
## How to contribute | ||
|
||
There are multiple ways to contribute to this project. The most common way is to fork this repository, make changes and open a pull request. If you're not sure what to work on, you can check the issues tab to see if there are any open issues which you can work on or if you have any ideas, you can open a new issue and discuss it. | ||
|
||
### Reporting bugs | ||
|
||
If you find any bugs, you can report them by [creating an bug report](https://github.com/AkashRajpurohit/ts-npm-template/issues/new?template=bug_report.md). Please make sure to include as much information as possible so that it's easier to reproduce the bug. | ||
|
||
### Requesting features | ||
|
||
If you feel that the project is missing a feature, you can raise a [feature request](https://github.com/AkashRajpurohit/ts-npm-template/issues/new?template=feature_request.md) on GitHub and I'll look into it or better yet, you can open a pull request with the feature. | ||
|
||
### Commit messages | ||
|
||
Please make sure to follow the [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) format while making changes. This helps in generating changelogs and versioning the package. | ||
|
||
--- | ||
|
||
That's it, go ahead and fork this repo and start 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