From 0f68046afa3c043e5483bae5302cc298e6029c83 Mon Sep 17 00:00:00 2001 From: Cell <1024@lruihao.cn> Date: Sat, 23 Aug 2025 04:19:55 +0800 Subject: [PATCH] docs: update contributing guidelines to follow Conventional Commits --- CONTRIBUTING.md | 52 ++----------------------------------------------- 1 file changed, 2 insertions(+), 50 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f968b689..ba4758ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,54 +117,6 @@ FixIt/ Finally, create a new pull request at to submit your contribution 🎉 -## Git standard for developers +## Git Commit Guidelines -### Branches - -| Branch | Description | -| :------------- | :----------------------------------------------------- | -| main | _The development branch, may contain unstable updates_ | -| single feature | _The branch to enhancements or fixes_ | - -### Merge events - -| event | merge | -| :------------- | :------------------------------------ | -| PR | **others:main => main:** `--rebase` | -| single feature | **feature branch => main:** `--merge` | - -### Commit message - -#### Format - -`[{emoji} ]{type}[({scope})]: {subject within 50 words}[ (#{issue/pull request})]` - -example: - -- :tada: Feat: add shortcode fixit-encryptor shortcode (#123) -- :arrow_up: Chore(libs): update Artalk from 2.2.12 to 2.3.4 (#150) - -#### Emoji - -- -- [vscode plugin](https://github.com/maixiaojie/git-emoji-zh.git) -- utools plugin `GitEmoji` - -#### 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 | -| :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 | - -> [!NOTE] -> The change log is automatically generated based on the commit message.\ -> A add `(ignore)` or `(i)` scope to ignore including in. +We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages. This enables automatic changelog generation using our custom template: [conventional.hbs](https://github.com/hugo-fixit/fixit-releaser/blob/main/changelog/conventional.hbs).