fuzzyjs
Version:
Simple fuzzy matching
34 lines (19 loc) • 1.73 kB
Markdown
# Contributing Guidelines
_Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!_ :octocat:
### Contents
- [Code of Conduct](#book-code-of-conduct)
- [Asking Questions](#bulb-asking-questions)
- [How can I Contribute?](#inbox_tray-how-can-i-contribute)
> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
## :book: Code of Conduct
Please review our [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
## :bulb: Asking Questions
If you have any question that does not relate to a bug or a feature request, please use [GitHub Discussions](https://github.com/gjuchault/typescript-library-starter/discussions) instead of GitHub issues.
## :inbox_tray: How can I Contribute?
**GitHub issues**
If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create [a new issue](https://github.com/gjuchault/typescript-library-starter/issues/new/choose).
**GitHub Pull requests**
Please leverage the repository's own tools to make sure the code is aligned with our standards:
1. Run all check commands before submitting the PR (`type:check`, `format:check`, `lint:check`, `test:coverage` and `spell:check`)
2. Please commit your changes and run a `setup` command so you can actually check how would the template look like once cleaned up
3. Always leverage the `cz` command to create a commit. We heavily rely on this for automatic releases.