Nice to see you here! I'm glad you took an interest in contributing to this project. All kinds of contributions are welcome, including:
- Reporting bugs
- Fixing bugs
- Proposing new features
Found a bug? Awesome! You can file an issue here. A great bug report typically contains:
- A quick summary of what you tried to achieve
- Steps to reproduce
- Please be specific and include code samples if you can
- What you expected to happen
- What actually happens
- Notes (maybe you have hints on what causes the issue or other things you tried that didn't help)
Even though as a developer, bugs can be annoying, the more detail is in your bug report, the more I will love reading it 😉
But please make sure that this hasn't already been reported!
You have an idea for a new feature or improvement? I'd love to hear it! Please file an issue here. A great feature request usually contains:
- A description on what you want to achieve or solve with the feature
- How it should work
But please make sure that this hasn't already been requested!
You want to fix a bug? Thank you 🙏 Here's how to get started.
There are only a couple of commands you need to use:
npm run lint
to lint the code using ESLintnpm run test
to run tests with Mochanpm run compile
to build the project with TypeScript
These packages are important to know about:
- TypeScript
- Commander (for the CLI)
- Zod (for config validation)
- Mocha and Sinon (for unit testing)
We use GitHub Flow, so everything happens through Pull Requests (PRs).
- Fork the repo and create your branch from
main
- If you've added code that needs testing, please also add tests
- Ensure the CI pipeline passes (including build, test and lint)
- Open the PR 😊
By contributing to the project, you agree that your contributions will be licensed under its MIT License.