First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you've found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
We will then take care of the issue as soon as possible.
- Usage of the Issue Template: Please use the bug report template when opening a new issue.
- Ensure the bug was not already reported: Search existing issues before creating a new one.
- Reproducible Test Case: If possible, provide a minimal reproducible example.
- Usage of the Issue Template: Please use the feature request template.
- Explain the benefit: Detail why this enhancement would be useful to most users.
- Clone the repository.
- Install dependencies with
pnpm install. - Run
pnpm devto start the development server.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less