From a3aa9f8b872ddf08adbd5b61148b08aa61289c09 Mon Sep 17 00:00:00 2001 From: JinnyYi Date: Fri, 10 Sep 2021 16:35:20 +0800 Subject: [PATCH 1/3] Proposal: Adopt commitizen/conventional-commit-types --- ...pt-commitizen-conventional-commit-types.md | 173 ++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 docs/rfcs/adopt-commitizen-conventional-commit-types.md diff --git a/docs/rfcs/adopt-commitizen-conventional-commit-types.md b/docs/rfcs/adopt-commitizen-conventional-commit-types.md new file mode 100644 index 000000000..284e67b40 --- /dev/null +++ b/docs/rfcs/adopt-commitizen-conventional-commit-types.md @@ -0,0 +1,173 @@ +- Author: JinnyYi +- Start Date: 2021-09-10 +- RFC PR: [beyondstorage/go-storage#0](https://github.com/beyondstorage/go-storage/pull/0) +- Tracking Issue: [beyondstorage/go-storage#0](https://github.com/beyondstorage/go-storage/issues/0) + +# Proposal: Adopt commitizen/conventional-commit-types + +Previous Discussion: + +- [Adopt commitizen/conventional-commit-types](https://forum.beyondstorage.io/t/topic/193) + +## Background + +Generally, the commit message should be clear and unambiguous, stating the purpose of this commit, what specific operations have been done... But in daily development, fix bug and other kinds of generalized messages are commonplace. And sometimes we don't even know what problem we are modifying with the commit, or the impact of a particular commit. This leads to the cost of subsequent code maintenance. + +Angular specification is currently the most widely used writing style, more reasonable and systematic, and has supporting tools. + +## Proposal + +Adopt `commitizen/conventional-commit-types` in our commits. + +Each commit message consists of a **header**, a **body**, and a **footer**. + +```txt +
+ + + +