Welcome your contributions! Please follow these guidelines:
Fork the repository.
Create a new branch for your feature or bug fix.
Write your code for the changes.
Commit your changes with a descriptive message.
Note: The commit message must follow the format below
Push your branch to your fork.
Submit a pull request to the main repository.
The commit message follows the Angular team commit guidelines, which are:
<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Meaning explained below.
You can install this VSCode extension to assist with filling in the message.
Must be one of the following types:
| Type | Explanation |
|---|---|
| 🎉 init | Project initialization |
| ✨ feat | Adding new features |
| 🐞 fix | Fixing bugs |
| 📃 docs | Modify documentation only |
| 🌈 style | Only the spaces, formatting, commas, etc. were changed, not the code logic |
| 🦄 refactor | Code refactoring, no new features added or bug fixed |
| 🎈 perf | Optimization-related, such as improving performance, experience |
| 🧪 test | Adding test cases |
| 🔧 build | Dependency-related content |
| 🐎 ci | CI configuration related e.g. changes to k8s, docker configuration files |
| 🐳 chore | Change build process, or add dependencies, tools, etc. |
| ↩ revert | Rollback to the previous version |
Subject.
The subject contains a brief description of the change.
Footer.
The footer should contain any information about major changes and is also the location to reference the GitHub Issue that this commit closes.
- Use Prettier to format your code.
- Never use hard-coded values. Use language file (assets/js/lang.js) instead.
- Please do not add any of your personal plugin configuration files.