Thank you for considering contributing to our project! We appreciate your interest in making it better. Please review the following guidelines to help streamline the process.
Please note that we have a Code of Conduct, which we expect all contributors to follow. Respectful and constructive interactions help everyone involved.
- Fork the repository.
- Clone your fork:
git clone https://github.com/your-username/your-forked-repo.git - Create a new branch for each feature or bugfix:
git checkout -b feature/your-feature-name - Make your changes and commit them following the commit standards below.
- Report Issues: Found a bug or have a suggestion? Feel free to open an issue.
- Submit Enhancements: If you have an idea for improving the project, please open an issue to discuss it before implementing changes.
- Help with Documentation: Improvements to our documentation are always welcome.
This project follows Conventional Commits. Please use the following types in your commit messages:
feat:for new featuresfix:for bug fixesdocs:for documentation changesstyle:for formatting (non-functional)refactor:for code changes that do not fix bugs or add featurestest:for adding or updating testschore:for maintenance
Example commit message: feat: add user authentication feature
This project uses Tailwind CSS for styling. Follow our existing patterns and utility classes to ensure consistency. Please avoid adding custom CSS if Tailwind provides a utility that accomplishes the same effect.
- Ensure your changes follow the above guidelines.
- Make sure all tests pass.
- Submit the pull request to the
mainbranch. - Your pull request should:
- Reference related issues if applicable (e.g.,
Closes #123) - Use a descriptive title following Conventional Commits
- Reference related issues if applicable (e.g.,
- Our team will review your pull request as soon as possible.
Thank you for your contribution!