From 2a95b70e5c6246f0e0dfd4d51b38d2755e237f0b Mon Sep 17 00:00:00 2001 From: zzyyyl Date: Sat, 24 Sep 2022 23:13:53 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20IssueBot=20?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/2.3-IssueBot使用方法.md | 48 +++++++++++-------------- docs/en-us/2.3-ISSUE_BOT_USAGE.md | 45 ++++++++++-------------- docs/ja-jp/2.3-IssueBotの使用方法.md | 45 ++++++++++-------------- docs/zh-tw/2.3-IssueBot使用方法.md | 52 ++++++++++++---------------- 4 files changed, 78 insertions(+), 112 deletions(-) diff --git a/docs/2.3-IssueBot使用方法.md b/docs/2.3-IssueBot使用方法.md index b9e511ca7b..ce239be5c8 100644 --- a/docs/2.3-IssueBot使用方法.md +++ b/docs/2.3-IssueBot使用方法.md @@ -1,6 +1,6 @@ -# Issue bot 使用方法 +# Issue Bot 使用方法 -Issue bot 使用的 action 为 [issue-checker](https://github.com/zzyyyl/issue-checker)，配置文件为 [issue-checker.yml](.github/issue-checker.yml)。 +Issue Bot 使用的 action 为 [issue-checker](https://github.com/zzyyyl/issue-checker)，配置文件为 [issue-checker.yml](.github/issue-checker.yml)。 **注意：拉取请求被增加 `ambiguous` 标签是因为没有按照 commitizen 规范提交。** @@ -8,55 +8,47 @@ Issue bot 使用的 action 为 [issue-checker](https://github.com/zzyyyl/issue-c ### 自动触发 -- 给上传文件失败的议题评论，告诉用户文件上传失败。 - 给 议题 和 拉取请求 增加标签，包括 `module` 系列，`Client` 系列，`ambiguous`，`translation required` 等。 - Issue bot 会根据关键词自动增加分类标签，也可以通过手动添加的方式增加或删除标签。 + Issue Bot 会根据关键词自动增加分类标签。 具体关键词可以参考[配置文件](.github/issue-checker.yml)。 -- 给可见性设置为 public 的 MAA 成员增加 `MAA Team` 标签。 +- 给作者是可见性设置为 public 的 MAA 成员的 议题 和 拉取请求 增加 `MAA Team` 标签。 + +#### 议题（Issue）及其评论 + +- 给上传文件失败的议题增加 `incomplete` 标签并评论，告诉用户文件上传失败。 #### 拉取请求（Pull Request） -Issue bot 会对拉取请求标题的格式进行简单审查。它会增加 `ambiguous` 标签，除非拉取请求标题以下列任一单词开头： +Issue Bot 会对拉取请求标题的格式进行简单审查。它会增加 `ambiguous` 标签，除非拉取请求标题以下列任一单词开头： - `build` `chore` `ci` `doc` `docs` `feat` `fix` `perf` `refactor` `rfc` `style` `test` - `Merge` `merge` `Revert` `revert` ### 手动触发 -多使用关键词详细描述问题来自动触发分类标签，少使用下列指令。但**当你知道自己的行为会导致 Issue bot 误解时除外**。 +多使用关键词详细描述问题来自动触发分类标签，少使用下列指令。 +但**当你知道自己的行为会导致 Issue Bot 误解时除外**。 -尽量不要直接增加或删除分类标签，因为手动增加或删除的分类标签可能在修改后会被恢复原样。 +#### 议题（Issue）及拉取请求（Pull Request） -#### 议题（Issue）及其评论 - -在 修改/新增 一个议题时： - -- `Add {LABEL_NAME}` 可以增加一个标签。 - `Remove {LABEL_NAME}` 可以删除一个标签。 - `Remove labels` 可以删除所有标签。 +- `Skip {LABEL_NAME}` 可以跳过一个标签。 +- `Skip labels` 可以跳过所有标签。 -在 修改/新增 一个议题评论时： +#### 议题评论（Issue Comments）及拉取请求评论（Pull Request Comments） -- `Add ambiguous` 可以保证不删除 `ambiguous` 标签，但没有 `ambiguous` 标签时不会添加。 -- `Remove {LABEL_NAME}` 可以保证不增加标签。1 -- `Remove labels` 可以保证不增加任何标签。1 -- 以下几种方法可以为议题增加 `fixed` 标签：2 +- `Skip {LABEL_NAME}` 可以保证不增加标签。 +- `Skip labels` 可以保证不增加任何标签。 +- 以下几种方法可以为议题增加 `fixed` 标签：1 - `https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed` - `fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}` - `{VERSION} fixed` - `fixed by {VERSION}` - `Duplicate of #{ISSUE_NUMBER}` 可以为当前议题增加 `duplicate` 标签。 -- **当你知道自己的议题评论会导致 Issue bot 误解时，尽量添加一些 remove 操作。** +- **当你知道自己的议题评论会导致 Issue Bot 误解时，尽量添加一些 skip 操作。** -_Note1: `Remove ambiguous` 和 `Remove labels` 会删除 `ambiguous` 标签。_ -_Note2: 这里的 COMMIT_HASH 需要完整的 40 位。_ - -#### 拉取请求（Pull Request）及其评论 - -与[议题（Issue）及其评论](#议题issue及其评论)基本相同。另外： - -- `Release {VERSION}` 会增加 `release` 标签。 -- **不会**自动添加 `fixed`, `duplicate` 标签。 +_Note1: 这里的 COMMIT_HASH 需要完整的 40 位。_ #### 推送（Push） diff --git a/docs/en-us/2.3-ISSUE_BOT_USAGE.md b/docs/en-us/2.3-ISSUE_BOT_USAGE.md index e0f63860d0..4accad5af6 100644 --- a/docs/en-us/2.3-ISSUE_BOT_USAGE.md +++ b/docs/en-us/2.3-ISSUE_BOT_USAGE.md @@ -8,11 +8,14 @@ The action of Issue Bot is [issue-checker](https://github.com/zzyyyl/issue-check ### Auto Notification -- Adds comments to notify users that the files of their issues are not uploaded successfully. -- Adds tags to issues and pull requests, e.g., `module`, `Client`, `ambiguous`, `translation required`, etc. - Issue Bot will add categories based on keywords. You can modify tags manually as well. +- Adds labels to issues and pull requests, e.g., `module`, `Client`, `ambiguous`, `translation required`, etc. + Issue Bot will add categories based on keywords. Please refer to the [configuration file](.github/issue-checker.yml) for the keywords. -- Adds `MAA Team` tag for MAA team members with public visibility. +- Adds the `MAA Team` label to issues and pull requests for MAA public team members. + +#### Issues and Their Comments + +- Adds label `incomplete` and comments to notify users that the files of their issues are not uploaded successfully. #### Pull Request @@ -25,44 +28,32 @@ Issue Bot will check the title of your pull request. Unless the title starts wit It is better to trigger Issue Bot with keywords instead of commands listed below, unless that **you are aware that your action may confuse Issue Bot**. -Try not to add or delete category tags manually because they may be removed after changes are made. +#### Issues and Pull Requests -#### Issues and Their Comments - -When adding/modifying an issue: - -- `Add {LABEL_NAME}` will add a new label. - `Remove {LABEL_NAME}` will delete a label. - `Remove labels` will delete all labels. +- `Skip {LABEL_NAME}` will skip a label. +- `Skip labels` will skip all labels. -When adding/modifying a comment: +#### Issue Comments and Pull Request Comments -- `Add ambiguous` will keep the `ambiguous` label, but will not add it if it is not present. -- `Remove {LABEL_NAME}` will make sure no labels of the specified type are added.1 -- `Remove labels` will make sure no labels are added.1 -- To add `fixed` tags, you can use any of the commands below:2 +- `Skip {LABEL_NAME}` will make sure no labels of the specified type are added. +- `Skip labels` will make sure no labels are added. +- To add `fixed` label, you can use any of the commands below:1 - `https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed` - `fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}` - `{VERSION} fixed` - `fixed by {VERSION}` -- `Duplicate of #{ISSUE_NUMBER}` will add `duplicate` tag to the issue. -- **You can add some `remove` operations if your comment may confuse Issue Bot.** +- `Duplicate of #{ISSUE_NUMBER}` will add `duplicate` label to the issue. +- **You can add some `skip` operations if your comment may confuse Issue Bot.** -_Note1: `Remove ambiguous` and `Remove labels` will delete `ambiguous` tag._ -_Note2: The `COMMIT_HASH` here is the full 40-character hash._ - -#### Pull Requests and Their Comments - -Similar to [#Issues and Their Comments](#issues-and-their-comments). Furthermore: - -- `Release {VERSION}` will add `release` tag. -- `fixed`, `duplicated` will **NOT** be auto-added. +_Note1: The `COMMIT_HASH` here is the full 40-character hash._ #### Push For any commit in a push: -- `fixed` tag will be added if the commit message contains one of the following: +- `fixed` label will be added if the commit message contains one of the following: - `fix #{ISSUE_NUMBER}` - `close #{ISSUE_NUMBER}` - `fix https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}` diff --git a/docs/ja-jp/2.3-IssueBotの使用方法.md b/docs/ja-jp/2.3-IssueBotの使用方法.md index 37139cf997..d5061c5f8c 100644 --- a/docs/ja-jp/2.3-IssueBotの使用方法.md +++ b/docs/ja-jp/2.3-IssueBotの使用方法.md @@ -8,11 +8,14 @@ Issue Botのアクションは[issue-checker](https://github.com/zzyyyl/issue-ch ### 自動通知 -- 必要なファイルが正常にアップロードされなかった場合に、その旨を通知するコメントを追加します。 -- `module`, `Client`, `ambiguous`, `translation required`などのタグをIssueおよびプルリクエストに追加します。 - Issue Botは、キーワードを元にカテゴリーを追加します。タグは手動で修正することもできます。 +- `module`, `Client`, `ambiguous`, `translation required`などのラベルをIssueおよびプルリクエストに追加します。 + Issue Botは、キーワードを元にカテゴリーを追加します。 キーワードは[設定ファイル](.github/issue-checker.yml)を確認して下さい。 -- MAAチームのメンバーが含まれている場合、`MAA Team`タグを追加しました。 +- MAAチームのメンバーが含まれている場合、`MAA Team`ラベルを追加しました。 + +#### Issuesとコメント + +- 必要なファイルが正常にアップロードされなかった場合に、その旨を通知するコメントを追加します。 #### プルリクエスト @@ -25,44 +28,32 @@ Issue Botはプルリクエストのタイトルをチェックします。タ **Issue Botを混乱させる可能性がありそうな内容の場合は**以下に示すコマンドではなく、キーワードでIssue Botを起動することをお勧めします。 -カテゴリタグは、変更後に削除される可能性があるため、手動で追加または削除しないようにしてください。 +#### Issuesとプルリクエスト -#### Issuesとコメント - -Issueを変更/追加する場合: - -- `add {LABEL_NAME}` で新しいラベルを追加します。 - `Remove {LABEL_NAME}` でラベルを削除します。 - `Remove labels` で全てのラベルを削除します。 +- `Skip {LABEL_NAME}` でラベルをスキップします。 +- `Skip labels` で全てのラベルをスキップします。 -コメントを追加/修正する場合: +#### Issueコメントとプルリクエストコメント -- `Add ambiguous` で `ambiguous` ラベルを追加しますが、既に存在する場合は追加されません。 -- `Remove {LABEL_NAME}` は、指定されたタイプのラベルが追加されないようにします。1 -- `Remove labels` は、ラベルが追加されないようにします。1 -- `fixed` タグを追加する場合、以下のいずれかのコマンドを使用します:2 +- `Skip {LABEL_NAME}` は、指定されたタイプのラベルが追加されないようにします。 +- `Skip labels` は、ラベルが追加されないようにします。 +- `fixed` ラベルを追加する場合、以下のいずれかのコマンドを使用します:1 - `https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed` - `fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}` - `{VERSION} fixed` - `fixed by {VERSION}` -- `Duplicate of #{ISSUE_NUMBER}` と入力するとissueに `duplicate` タグを追加します。 -- **あなたのコメントがIssue Botを混乱させる可能性がある場合、下記の `remove` コマンドを追加できます。** +- `Duplicate of #{ISSUE_NUMBER}` と入力するとissueに `duplicate` ラベルを追加します。 +- **あなたのコメントがIssue Botを混乱させる可能性がある場合、下記の `skip` コマンドを追加できます。** -_Note1: `Remove ambiguous` と `Remove labels` は `ambiguous` タグを削除します。_ -_Note2: `COMMIT_HASH` は 40 文字の完全なハッシュです。_ - -#### プルリクエストとコメント - -[Issuesとコメント](#issuesとコメント)と同様です。 更に使用可能: - -- `Release {VERSION}` で `release` タグを追加します。 -- `fixed`, `duplicated` は **自動的に追加されません**。 +_Note1: `COMMIT_HASH` は 40 文字の完全なハッシュです。_ #### プッシュ プッシュ中でもコミット可能です: -- `fixed` タグは、コミットメッセージに以下のいずれかが含まれている場合に追加されます: +- `fixed` ラベルは、コミットメッセージに以下のいずれかが含まれている場合に追加されます: - `fix #{ISSUE_NUMBER}` - `close #{ISSUE_NUMBER}` - `fix https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}` diff --git a/docs/zh-tw/2.3-IssueBot使用方法.md b/docs/zh-tw/2.3-IssueBot使用方法.md index 0f297641d9..f997495c79 100644 --- a/docs/zh-tw/2.3-IssueBot使用方法.md +++ b/docs/zh-tw/2.3-IssueBot使用方法.md @@ -1,6 +1,6 @@ -# Issue bot 使用方法 +# Issue Bot 使用方法 -Issue bot 使用的 action 為 [issue-checker](https://github.com/zzyyyl/issue-checker)，設定檔為 [issue-checker.yml](.github/issue-checker.yml)。 +Issue Bot 使用的 action 為 [issue-checker](https://github.com/zzyyyl/issue-checker)，設定檔為 [issue-checker.yml](.github/issue-checker.yml)。 **注意：拉取請求被增加 `ambiguous` 標籤是因為沒有按照 commitizen 規範提交。** @@ -8,55 +8,47 @@ Issue bot 使用的 action 為 [issue-checker](https://github.com/zzyyyl/issue-c ### 自動觸發 -- 給上傳檔案失敗的議題評論，告訴使用者檔案上傳失敗。 - 給 議題 和 拉取請求 增加標籤，包括 `module` 系列，`Client` 系列，`ambiguous`，`translation required` 等。 - Issue bot 會根據保留字自動增加分類標籤，也可以透過手動添加的方式增加或刪除標籤。 + Issue Bot 會根據保留字自動增加分類標籤。 具體保留字可以參考[設定檔](.github/issue-checker.yml)。 -- 給可見性設置為 public 的 MAA 成員增加 `MAA Team` 標籤。 +- 給作者是可見性設置為 public 的 MAA 成員的 議題 和 拉取請求 增加 `MAA Team` 標籤。 + +#### 議題（Issue）及其評論 + +- 給上傳檔案失敗的議題增加 `incomplete` 標籤并評論，告訴使用者檔案上傳失敗。 #### 拉取請求（Pull Request） -Issue bot 會對拉取請求標題的格式進行簡單審查。它會增加 `ambiguous` 標籤，除非拉取請求標題以下列任一單字開頭： +Issue Bot 會對拉取請求標題的格式進行簡單審查。它會增加 `ambiguous` 標籤，除非拉取請求標題以下列任一單字開頭： - `build` `chore` `ci` `doc` `docs` `feat` `fix` `perf` `refactor` `rfc` `style` `test` - `Merge` `merge` `Revert` `revert` ### 手動觸發 -多使用保留字詳細描述問題來自動觸發分類標籤，少使用下列指令。但**當你知道自己的行為會導致 Issue bot 誤解時除外**。 +多使用保留字詳細描述問題來自動觸發分類標籤，少使用下列指令。 +但**當你知道自己的行為會導致 Issue Bot 誤解時除外**。 -盡量不要直接增加或刪除分類標籤，因為手動增加或刪除的分類標籤可能在修改後會被恢復原樣。 +#### 議題（Issue）及拉取請求（Pull Request） -#### 議題（Issue）及其評論 +- `Remove {LABEL_NAME}` 可以删除一個標籤。 +- `Remove labels` 可以删除所有標籤。 +- `Skip {LABEL_NAME}` 可以跳过一個標籤。 +- `Skip labels` 可以跳过所有標籤。 -在 修改/新增 一個議題時： +#### 議題評論（Issue Comments）及拉取請求評論（Pull Request Comments） -- `Add {LABEL_NAME}` 可以增加一個標籤。 -- `Remove {LABEL_NAME}` 可以刪除一個標籤。 -- `Remove labels` 可以刪除所有標籤。 - -在 修改/新增 一個議題評論時： - -- `Add ambiguous` 可以保證不刪除 `ambiguous` 標籤，但沒有 `ambiguous` 標籤時不會添加。 -- `Remove {LABEL_NAME}` 可以保證不增加標籤。 1 -- `Remove labels` 可以保證不增加任何標籤。 1 -- 以下幾種方法可以為議題增加 `fixed` 標籤：2 +- `Skip {LABEL_NAME}` 可以保證不增加標籤。 +- `Skip labels` 可以保證不增加任何標籤。 +- 以下幾種方法可以為議題增加 `fixed` 標籤：1 - `https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH} fixed` - `fixed by https://github.com/MaaAssistantArknights/MaaAssistantArknights/commit/{COMMIT_HASH}` - `{VERSION} fixed` - `fixed by {VERSION}` - `Duplicate of #{ISSUE_NUMBER}` 可以為當前議題增加 `duplicate` 標籤。 -- **當你知道自己的議題評論會導致 Issue bot 誤解時，盡量添加一些 remove 操作。** +- **當你知道自己的議題評論會導致 Issue Bot 誤解時，盡量添加一些 skip 操作。** -_Note1: `Remove ambiguous` 和 `Remove labels` 會刪除 `ambiguous` 標籤。_ -_Note2: 這裡的 COMMIT_HASH 需要完整的 40 位。_ - -#### 拉取請求（Pull Request）及其評論 - -與[議題（Issue）及其評論](#議題issue及其評論)基本相同。另外： - -- `Release {VERSION}` 會增加 `release` 標籤。 -- **不會**自動添加 `fixed`, `duplicate` 標籤。 +_Note1: 這裡的 COMMIT_HASH 需要完整的 40 位。_ #### 推送（Push）