Thank you for considering contributing to this project! We welcome contributions from everyone.
- Fork the repository and clone it locally
- Install dependencies:
npm install - Create a branch for your changes:
git checkout -b my-feature-branch
- Make your changes in your feature branch
- Write or update tests as needed
- Ensure all tests pass:
npm test - Follow the existing code style and conventions
- Write clear, concise commit messages
- Push your changes to your fork
- Open a pull request against the
mainbranch - Provide a clear description of the changes
- Link any related issues
- Wait for review and address any feedback
- Use consistent formatting (we use Prettier/ESLint)
- Write meaningful variable and function names
- Add comments for complex logic
- Keep functions small and focused
- Use the issue templates provided
- Include as much detail as possible
- Provide steps to reproduce bugs
- Include system/environment information
Feel free to open an issue for any questions or concerns.
By participating in this project, you agree to abide by our Code of Conduct.