From 94553e9b8edf8b700fa8e20e5ed340aaa1b69d54 Mon Sep 17 00:00:00 2001 From: Cell <1024@lruihao.cn> Date: Tue, 6 Aug 2024 17:30:47 +0800 Subject: [PATCH] :pencil: Docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19980c24..b686395c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,22 +43,21 @@ Finally, create a new pull request at master:** `--rebase` | +| release | **dev => master:** `--rebase` | | PR | **others:master => master:** `--rebase` | -| single feature| **feature branch => RC branch:** `--merge` | +| single feature| **feature branch => dev/master:** `--merge` | ### Commit message #### Format -`[{emoji} ]{type}[({module})]: {subject within 50 words}[ (#{issue/pull request})]` +`[{emoji} ]{type}[({scope})]: {subject within 50 words}[ (#{issue/pull request})]` example: @@ -73,15 +72,19 @@ example: #### Message -| Emoji | Type | Example | Description (No Ambiguous) | -| :-------------------------------------------- | :------- | :----------------------------------------------------------- | :----------------------------------------------------------- | -| :tada:
:sparkles: | Feat | Feat: add {feature} | new feature | -| :truck: | | Feat: adjust/migrate {feature name}, {change details} | For the adjustment feature, it is necessary to describe the current situation (before) and after adjustment (after) | -| :fire: | | Feat: delete {feature name}, {deletion reason} | If the feature is deleted, the reason for deletion must be explained | -| :bug:
:construction:
:rotating_light: | Fix | Fix: fix {bug description} | Fix known bugs | -| :art:
:lipstick:
:pencil2: | Style | Style: Typesetting/CSS style {optimizing content} | Changes that do not affect code operation, such as code layout and style change | +| Emoji | Type | Example | Description (No Ambiguous) | +| :-------------------------------------------- | :------- | :----------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | +| :tada:
:sparkles: | Feat | Feat: add {feature} | new feature | +| :truck: | | Feat: adjust/migrate {feature name}, {change details} | For the adjustment feature, it is necessary to describe the current situation (before) and after adjustment (after) | +| :fire: | | Feat: delete {feature name}, {deletion reason} | If the feature is deleted, the reason for deletion must be explained | +| :bug:
:construction:
:rotating_light: | Fix | Fix: fix {bug description} | Fix known bugs | +| :art:
:lipstick:
:pencil2: | Style | Style: Typesetting/CSS style {optimizing content} | Changes that do not affect code operation, such as code layout and style change | | :recycle: | Refactor | Refactor: override {feature name} | It is neither a new function nor a code change to fix a bug. Simply rewriting the code of a function does not affect the function result | -| :zap: | Perf | Perf: improve performance {function name}, {improve content} | Optimize code performance | -| :rewind: | Revert | Revert: restore version {commit message of restore version} | Restore the version of one commit | -| :pencil:
:pencil2: | Docs | Docs: revise comments/update documents | Adjustment of documents and notes | -| :wrench: | Chore | Chore: update plugin version | Changes in the construction process or auxiliary tools | +| :zap: | Perf | Perf: improve performance {function name}, {improve content} | Optimize code performance | +| :rewind: | Revert | Revert: restore version {commit message of restore version} | Restore the version of one commit | +| :pencil:
:pencil2: | Docs | Docs: revise comments/update documents | Adjustment of documents and notes | +| :wrench: | Chore | Chore: update plugin version | Changes in the construction process or auxiliary tools | + +> [!note] +> The change log is automatically generated based on the commit message.\ +> Use `Chore` type or add `(ignore)` scope to ignore including in.