feat: Add ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE (didi#19)

* chore: Add ISSUE_TEMPLATE.md * chore: Move .github folder to root * chore: Complete PULL_REQUEST_TEMPLATE.md and CHANGELOG.md
daodaolee · Jan 11, 2021 · ca3c6e6 · ca3c6e6
1 parent 6abbdf1
commit ca3c6e6
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,27 @@
+---
+name: 🐛 Bug Report
+about: Report a reproducible bug or regression in Hummer.
+labels: Needs: Triage 🔍
+---
+请提供所要求的所有资料。不遵循此格式的问题可能会停滞。
+
+## 描述
+请提供一个明确和简洁的描述什么是错误。如果需要，包括屏幕截图。
+请使用最新的 Hummer 版本（master/main 分支）进行测试，以确保您的问题尚未修复。
+
+## Hummer version:
+提供出现问题的 Hummer 版本号
+
+## Steps To Reproduce
+提供重现问题的详细步骤列表。
+
+1.
+2.
+
+## 预期结果
+描述你期望发生的事情。
+
+## 样例代码、屏幕截图或者仓库链接
+请提供一个 GitHub 仓库链接或者提供一段最小复现代码。
+如果您认为该应用程序与您的错误报告相关，则可以提供该应用程序的屏幕截图。
+以下是一些提示，可以提供一个简单的示例：https://stackoverflow.com/help/mcve
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,16 @@
+<!-- 感谢您提交拉取请求（Pull Request）！我们感谢您花时间进行这些更改。请提供足够的信息，以便其他人可以查看您的请求。以下三个字段是必填字段。 -->
+
+## Summary
+
+<!-- 解释做出这一改变的**动机**。拉取请求解决了哪些现有问题？ -->
+
+## Changelog
+
+<!-- 通过编写自己的变更日志（ChangeLog）条目来帮助审阅者和发布过程。例如：https://github.com/didi/Hummer/blob/master/docs/CHANGELOG.md -->
+
+[CATEGORY] [TYPE] - Message
+
+## Test Plan
+
+<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes the user interface. -->
+<!-- 证明代码是可靠的。示例：您运行的确切命令及其输出、屏幕截图/视频（如果拉取请求更改了用户界面）。 -->
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1,41 @@
+## 拉取请求（Pull Request）中的变更日志（ChangeLog）
+变更日志条目用于在拉取请求中提供一系列太长不读（tl;dr:）的内容：会影响 Android 吗？是否存在破坏性变更（Breaking Change）？有什么新内容被添加了吗？
+
+使用标准格式提供变更日志有助于编写发行说明。请在请求描述中包含一个变更日志。如果拉取请求被合并，则拉取请求描述将用作提交消息。 
+
+### 格式
+一条变更日志条目有如下格式
+```
+## Changelog:
+
+[Category] [Type] - Message
+```
+
+这个 "Category" 域可能是下列之一：
+* Android，这些改变会影响 Android
+* iOS，这些变更会影响 iOS
+* General，这些变更不适合使用其他分类类型
+* Internal，这些变更对阅读发行注记（Release Note）的开发人员无关
+
+这个 "Type" 域可能是下列之一：
+* Added，新添加的特性
+* Changed，改变了现有功能的特性
+* Deprecated，未来会被移除的特性
+* Removed，现在被移除的功能
+* Fixed，问题修复
+* Security，安全问题
+
+最后，"Message" 字段在功能级别回答“什么和为什么”。用这个简单地告诉用户应当注意的的变化。
+
+更多信息，请参阅 [How do I make a good changelog?](https://keepachangelog.com/en/1.0.0/#how) 和 [Why keep a changelog?](https://keepachangelog.com/en/1.0.0/#why)
+
+### 样例
+* `[General] [Added] - Add snapToOffsets prop to ScrollView component`
+* `[General] [Fixed] - Fix various issues in snapToInterval on ScrollView component`
+* `[iOS] [Fixed] - Fix crash in HMImageView`
+
+### FAQ
+* **如果我的拉取请求同时包含对 Android 和 JavaScript 的更改怎么办？** 使用 Android 类别。
+* **如果我的拉取请求同时包含对 Android 和 iOS 的更改怎么办？** 如果更改是在单个拉取请求中进行的，请使用 General 类别。
+* **如果我的拉取请求同时包含对 Android、iOS 和 JavaScript 的更改怎么办？** 如果更改是在单个拉取请求中进行的，请使用 General 类别。
+* **如果……怎么办？？** 任何变更日志条目都比没有好。如果您不确定是否挑选了正确的分类，请使用 "Message" 字段简洁描述您的更改