First, run the development server:
pnpm run devCommit messages in this project should follow the following format to ensure consistency and clarity:
<type>(<scope>): <message>
<type>: The type of the commit, which must be one of the following:
| Type | Description |
|---|---|
feat |
Add a new feature, enhancement, or functionality. |
fix |
Fix a bug or resolve an issue. |
perf |
Optimize code for improved performance. |
refactor |
Restructure code without altering its behavior. |
style |
Address code formatting and style conventions. |
docs |
Make modifications to documentation. |
test |
Add, modify, or refactor test cases. |
chore |
Handle routine tasks, maintenance, or dependency management. |
revert |
Revert previous code changes. |
move |
Relocate files, directories, or code to a new location. |
remove |
Delete redundant or unnecessary code, files, or directories. |
ci |
Update Continuous Integration/Continuous Deployment (CI/CD) configurations. |
<scope>(optional): The scope or context of the commit, indicating the affected module, file, or feature.<message>: A concise and clear description of the commit.
Here are some example commit messages that adhere to the convention:
feat(auth): add user login functionalityfix(api): resolve data processing errorstyle(css): update styling for the login pagedocs(readme): update project descriptiontest(unit): add tests for user management modulechore(deps): update package dependenciesrevert: revert previous commitmove(src): move model classes to a new directoryremove(deprecated): remove unused functionsci(travis): update test environment configuration
You can view the Storybook for this project on Chromatic: