If you come across a bug or unexpected behavior, please take the time to report it. To file a bug report:
- Check if the issue has already been reported by searching the issues.
- If the issue hasn't been reported yet, open a new issue, providing as much detail as possible, including:
- A clear and concise title.
- A detailed description of the issue.
- Steps to reproduce the problem.
- Expected and actual behavior.
To propose a new feature:
- Check the issues to ensure it hasn't been proposed before.
- Open a new issue, clearly describing the new feature or enhancement you would like to see.
- Provide any relevant details or use cases that will help understand the use of the proposed feature.
To contribute code:
- Fork the repository.
- Create a new branch for your changes with a specific prefix:
git checkout -b feat/your-feature. Accepted prefixes: feat, fix, refactor, docs. - Make your changes, following the coding style.
- Lint, format, and typecheck the code with
pnpm run format && pnpm run check. - Update the README or documentation if necessary.
- Submit a pull request to the dev branch of the original repository.
- Provide a detailed description in the pull request, explaining the purpose of your changes.