Skip to content

Commit

Permalink
docs: 📝 contributing instructions added
Browse files Browse the repository at this point in the history
  • Loading branch information
AkashRajpurohit committed Mar 25, 2024
1 parent 4451739 commit 585cb38
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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 🍻
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ Once you have followed the steps above and created a gist, uncomment these lines
- 🔀 [Github Actions](https://github.com/features/actions) - CI pipelines
- 💪 [PNPM](https://pnpm.io/) - Package manager

## Contributing 🫱🏻‍🫲🏼

Follow the [contribution guidelines](./CONTRIBUTING.md) to contribute to this project.

## Bugs or Requests 🐛

If you encounter any problems feel free to open an [issue](https://github.com/AkashRajpurohit/ts-npm-template/issues/new?template=bug_report.md). If you feel the project is missing a feature, please raise a [ticket](https://github.com/AkashRajpurohit/ts-npm-template/issues/new?template=feature_request.md) on GitHub and I'll look into it. Pull requests are also welcome.
Expand Down

0 comments on commit 585cb38

Please sign in to comment.