Commit rules

Commit Rules

The commit information includes three fields: Type(required), Subject(required), and Issueid

1. Type. Type is used to describe the type of the commit. The specified type is as follows:

   The common types are as follows:

   • add: added new files (such as videos, pictures, documents, etc.)

   • update: update the content of existing files

   • delete: delete some original files

   • misc: some submissions that are not classified or do not know what to classify it into

   Common types of technical posts are as follows:

   • feat: add a complete new feature to the code

   • fix: fix bug

   • docs: write engineering documents

   • style: code format change (it does not affect the format change of code operation. Note that it does not refer to the modification of CSS)

   • refactor: refactoring (neither new features nor code changes to modify bugs)

   • test: submit test code (unit test, integration test, etc.)

   • chore: changes to build or assist tools

2. Subject. Subject is a short description of the purpose of the commit, and the writing language is not limited. It is recommended to start with a verb in the first person present tense, such as modify instead of modified or modified, with a lowercase initial and no period at the end.

3. Issueid

Tips for Reference

• Reference on User ====> @username
• Reference on Issue ====> #issueid
• Reference on MR ====> !mrid
• Reference on Epic ====> &epicid