Merge pull request #2 from wallsman/patch-11

Patch 11
This commit is contained in:
Wallsman
2022-09-12 23:14:45 +09:00
committed by GitHub

View File

@@ -0,0 +1,69 @@
# Issue Botの使用方法
Issue Botのアクションは[issue-checker](https://github.com/zzyyyl/issue-checker)になっており、設定ファイルである[issue-checker.yml](.github/issue-checker.yml)を利用します。
**Commitizenの仕様でコミットしていない場合、マージリクエストは`ambiguous`とマークされることに注意してください。**
## 特徴
### 自動通知
- 必要なファイルが正常にアップロードされなかった場合に、その旨を通知するコメントを追加します。
- `module`, `Client`, `ambiguous`, `translation required`などのタグを課題およびプルリクエストに追加します。
Issue Botは、キーワードを元にカテゴリーを追加します。タグは手動で修正することもできます。
キーワードは[設定ファイル](.github/issue-checker.yml)を確認して下さい。
- MAAチームのメンバーが含まれている場合、`MAA Team`タグを追加しました。
#### プルリクエスト
Issue Botはプルリクエストのタイトルをチェックします。タイトルが以下のキーワードで始まっていない限り、プルリクエストは `ambiguous` としてマークされます。
- `build` `chore` `ci` `doc` `docs` `feat` `fix` `perf` `refactor` `rfc` `style` `test`
- `Merge` `merge` `Revert` `revert`
### 手動でトリガーを発動させる
**Issue Botを混乱させる可能性がありそうな内容の場合は**以下に示すコマンドではなく、キーワードでIssue Botを起動することをお勧めします。
カテゴリタグは、変更後に削除される可能性があるため、手動で追加または削除しないようにしてください。
#### Issuesとコメント
Issueを変更/追加する場合:
- `add {LABEL_NAME}` で新しいラベルを追加します。
- `Remove {LABEL_NAME}` でラベルを削除します。
- `Remove labels` で全てのラベルを削除します。
コメントを追加/修正する場合:
- `Add ambiguous``ambiguous` ラベルを追加しますが、既に存在する場合は追加されません。
- `Remove {LABEL_NAME}` は、指定されたタイプのラベルが追加されないようにします。<sup>1</sup>
- `Remove labels` は、ラベルが追加されないようにします。<sup>1</sup>
- `fixed` タグを追加する場合、以下のいずれかのコマンドを使用します:<sup>2</sup>
- `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` コマンドを追加できます。**
_Note<sup>1</sup>: `Remove ambiguous` と `Remove labels` は `ambiguous` タグを削除します。_
_Note<sup>2</sup>: `COMMIT_HASH` は 40 文字の完全なハッシュです。_
#### プルリクエストとコメント
[#Issues and Their Comments](#issues-and-their-comments)と同様です。 更に使用可能:
- `Release {VERSION}``release` タグを追加します。
- `fixed`, `duplicated`**自動的に追加されません**
#### プッシュ
プッシュ中でもコミット可能です:
- `fixed` タグは、コミットメッセージに以下のいずれかが含まれている場合に追加されます:
- `fix #{ISSUE_NUMBER}`
- `close #{ISSUE_NUMBER}`
- `fix https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}`
- `close https://github.com/MaaAssistantArknights/MaaAssistantArknights/issues/{ISSUE_NUMBER}`