Thank you for contributing to this project! To keep everything organized and consistent, we follow a set of conventions for naming pull requests (PRs) and commits. Please review the guidelines below before submitting your changes.
Pull Request Title Format
When creating a PR, the title must follow the Conventional Commits format:
Allowed Prefixes
- feat: For adding new features.
- fix: For bug fixes.
- docs: For changes to the documentation.
- style: For code style changes (e.g., formatting, missing semicolons).
- refactor: For code restructuring that doesn’t add new features or fix bugs.
- perf: For performance improvements.
- test: For adding or updating tests.
- build: For changes related to the build system or dependencies.
- chore: For other changes (e.g., updates to tooling, configs).
- revert: For reverting a previous commit.
Examples
- ✅ feat: add user authentication flow
- ✅ fix: resolve crash when loading dashboard
- ❌ Added new feature
- ❌ Bug fix in login functionality
By following these guidelines, you help keep the project organized and maintainable. Thank you for your contributions! 🚀