From a5dc32061b333c58a28e635c4ae12beaeece67d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A4=8D=E4=BA=88?= Date: Wed, 29 May 2024 12:59:48 +0800 Subject: [PATCH] Add issue and PR templates (#4) * Add new article request template * Add error report template * Add PR template --- .github/ISSUE_TEMPLATE/error-report.yaml | 54 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/request-new.yaml | 45 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/template.md | 14 ++++++ 3 files changed, 113 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/error-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/request-new.yaml create mode 100644 .github/PULL_REQUEST_TEMPLATE/template.md diff --git a/.github/ISSUE_TEMPLATE/error-report.yaml b/.github/ISSUE_TEMPLATE/error-report.yaml new file mode 100644 index 0000000..e9b547e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/error-report.yaml @@ -0,0 +1,54 @@ +name: 内容捉虫 +description: 报告现有内容的各种错误 +title: "[Bug] " +labels: ["!template", "!report"] + +body: + - type: markdown + attributes: + value: | + 请使用此模板填写目前仓库已有内容中的各种错误。 + - type: dropdown + id: bug_type + attributes: + label: 报告类别 + description: 错误的所属类别。 + options: + - 事实性错误(如内容不符合事实) + - 内容过期(条款、界面等文件已有更新) + - 语法错误(用词、语句有误) + - 目标错误(感觉被冒犯、不适合全受众) + validations: + required: true + - type: input + id: source + attributes: + label: 文章位置 + description: 在下方填入涉及文章的静态链接,以便我们定位问题。 + validations: + required: true + - type: textarea + id: reason + attributes: + label: 理由或证据 + description: 指出问题所在,请务必具体精准。如有相关资料、链接或图片,请附上。 + validations: + required: true + - type: textarea + id: suggestion + attributes: + label: 修改方式 + description: 你认为如何解决该问题最好?如果你有方案,请在此指出。没有可留空。 + - type: checkboxes + id: terms + attributes: + label: 提交前请确认 + description: | + 在提交此问题前,请核对并确认: + options: + - label: 已填入所需内容,问题描述合理清晰 + required: true + - label: 已在问题与讨论列表中查找过,没有相似的问题与请求 + required: true + - label: 我保证填写的信息真实准确,并从客观视角阐释事实 + required: true diff --git a/.github/ISSUE_TEMPLATE/request-new.yaml b/.github/ISSUE_TEMPLATE/request-new.yaml new file mode 100644 index 0000000..4562e2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-new.yaml @@ -0,0 +1,45 @@ +name: 新文章请求 +description: 希望站点收集的新文章,你来写、我来写、其他人来写都可以。 +title: "[NA] " +labels: ["!template"] + +body: + - type: markdown + attributes: + value: | + 请使用此模板填写目前仓库**未收集的**文章与内容。 + - type: dropdown + id: req_type + attributes: + label: 请求类别 + description: 你需要请求什么类型的文章?请在下面选择。 + options: + - 我有新想法,希望有人来写 + - 我有好主意,希望自己来写 + - 在其他地方看到了好文章,希望本站收录 + validations: + required: true + - type: input + id: source + attributes: + label: 文章来源 + description: 如果你选择请求转载,请在此标明文章来源(平台+静态链接),以便确认版权。若选择了其他选项可留空。 + - type: textarea + id: content + attributes: + label: 想法与推荐理由 + description: 根据上方的选择,在这里填入你的想法或推荐转载文章的理由。可包括文章主题、相关性等内容。 + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: 提交前请确认 + description: | + 在提交此问题前,请核对并确认: + options: + - label: 已填入所需内容,问题描述合理清晰 + required: true + - label: 已在问题与讨论列表中查找过,没有相似的问题与请求 + required: true + diff --git a/.github/PULL_REQUEST_TEMPLATE/template.md b/.github/PULL_REQUEST_TEMPLATE/template.md new file mode 100644 index 0000000..d9028b8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/template.md @@ -0,0 +1,14 @@ +这是默认的拉取请求模板。请按照下面的指示,参考你做出的更改,提供所需的信息。在填入这些信息后,可以删除此说明。 + +当然,你也可以按照自己的喜好写一个。 + +## 更改说明 + +用简要的几句话描述分支做出的更改。如: + +- 更新`这篇文章`中的过期内容 +- 添加`新文章` + +## 相关问题 + +如果能解决问题,请按照 Github 文档中所述,使用关闭词链接问题。