Thank you for investing your time in contributing to Knip!
Read our Code of Conduct to keep our community approachable and respectable.
- Star the project to show your support
- Share Knip in social media or blog posts
- Open an issue
- Open a pull request to:
- Fix a bug
- Add a new feature
- Add a new plugin
- Improve output or add a new reporter
- Improve documentation
- Improve performance or architecture
The main goal of Knip is to keep projects clean & tidy. Everything that contributes to that goal is welcome!
Feel free to open an issue for things like this:
- Knip throws an error.
- Knip shows incorrect output, e.g. it reports false negatives.
- Documentation is incorrect or something is missing.
- Questions about configuration or how to run Knip.
- Discuss whether to start a pull request.
- Request a new feature.
Before you open an issue:
- Make sure you're using the latest version of Knip (see https://github.com/webpro/knip/releases)
- Use GitHub search to find related questions, known issues, etc.
- If relevant, use the
--debugflag which might reveal errors, potential issues with configuration, etc.
Pull requests are welcome!
Please consider this before opening a pull request:
- Open an issue before starting the work if for any reason you're not 100% sure about it. We can optimize both your and my time if we discuss ideas and choose a direction upfront.
- Read development instructions and guidelines.
- If you think your PR is not ready for review yet, set it as a draft.
- No need to worry about commit messages, they will probably be squashed into a single commit when merged.
- After your first PR is merged, you are automatically added to the list of contributors.