RFC-44: Use git-chglog (#44)

* proposal: Use git-chglog Signed-off-by: Xuanwo <[email protected]> * Assign number Signed-off-by: Xuanwo <[email protected]> * Add comment Signed-off-by: Xuanwo <[email protected]> * Update RFC PR Signed-off-by: Xuanwo <[email protected]>
maintainer-org · Aug 3, 2021 · 0e6233a · 0e6233a
1 parent 4ee4c57
commit 0e6233a
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 0 deletions.
diff --git a/docs/rfcs/0-example.md b/docs/rfcs/0-example.md
@@ -0,0 +1,41 @@
+- Author: (fill me in with `name <mail>`, e.g., Name <[email protected]>)
+- Start Date: (fill me in with today's date, YYYY-MM-DD)
+- RFC PR: [maintainer-org/maintainer#0](https://github.com/maintainer-org/maintainer/issues/0)
+- Tracking Issue: [maintainer-org/maintainer#0](https://github.com/maintainer-org/maintainer/issues/0)
+
+# RFC-0: <proposal name>
+
+- Updates: (delete this part if not applicable)
+    - [RFC-20](./20-abc): Deletes something
+- Updated By: (delete this part if not applicable)
+    - [RFC-10](./10-do-be-do-be-do): Adds something
+    - [RFC-1000](./1000-lalala): Deprecates this RFC
+
+## Background
+
+Explain why we are doing this.
+
+Related issues and early discussions can be linked, but the RFC should try to be self-contained if possible.
+
+## Proposal
+
+<proposal's content>
+
+## Rationale
+
+<proposal's rationale content, other implementations>
+
+Possible content:
+
+- Design Principles
+- Drawbacks
+- Alternative implementations and comparison
+- Possible Q&As
+
+## Compatibility
+
+<proposal's compatibility statement>
+
+## Implementation
+
+Explain what steps should be done to implement this proposal.
diff --git a/docs/rfcs/44-use-git-chglog.md b/docs/rfcs/44-use-git-chglog.md
@@ -0,0 +1,37 @@
+- Author: Xuanwo <[email protected]>
+- Start Date: 2021-08-03
+- RFC PR: [maintainer-org/maintainer#44](https://github.com/maintainer-org/maintainer/pull/44)
+- Tracking Issue: [maintainer-org/maintainer#0](https://github.com/maintainer-org/maintainer/issues/0)
+
+# RFC-44: Use git-chglog
+
+## Background
+
+We used to use [github-changelog-generator] for changelog generation.
+
+But [github-changelog-generator] is written in ruby, and users need to install it first:
+
+```shell
+$ gem install github_changelog_generator
+```
+
+## Proposal
+
+So I propose to use [git-chglog] to replace the dependence on [github-changelog-generator].
+
+## Rationale
+
+N/A
+
+## Compatibility
+
+The template could be incompatible. And we have to set up a migration plan.
+
+It's hard to migrate via coding, maybe we can have the migrate plan in document.
+
+## Implementation
+
+N/A
+
+[github-changelog-generator]: https://github.com/github-changelog-generator/github-changelog-generator
+[git-chglog]: https://github.com/git-chglog/git-chglog