Thank you for considering contributing to this project! 🎉
- Check if the bug has already been reported in Issues
- Use a clear and descriptive title
- Describe the steps to reproduce the issue
- Include screenshots if applicable
- Use a clear and descriptive title
- Provide a detailed description of the proposed feature
- Explain why this enhancement would be useful
- Fork the repository
- Create a new branch from
main:- Use descriptive branch names (e.g.,
fix-bug-123,add-feature-x)
- Use descriptive branch names (e.g.,
- Make your changes
- Write clear, concise commit messages
- Follow the existing code style
- Test your changes thoroughly
- Submit a pull request
- Provide a clear description of the changes
- Reference any related issues
feature/- for new featuresfix/- for bug fixesdocs/- for documentation updatesrefactor/- for code refactoring
- Use present tense ("Add feature" not "Added feature")
- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
- Keep the first line under 50 characters
- Reference issues when applicable (#123)
- Follow the existing code style in the project
- Use meaningful variable and function names
- Comment your code when necessary
Feel free to open an issue for any questions or concerns!
Please be respectful and constructive in all interactions.