diff --git a/How-Kodo-Works.md b/How-Kodo-Works.md new file mode 100644 index 0000000..c7b0d9e --- /dev/null +++ b/How-Kodo-Works.md @@ -0,0 +1,40 @@ +# Gitea VCS Usage + +## Introduction + +When working with Gitea, you can use several methods to interact with the tool. + +## 1. Launch of code review + +To start a code review, you must first prepare the following: + +1. Push the branch with changes to the remote repository +2. Create a Pull Request in Gitea VCS, adding the `@kodobot` reviewer user to the Pull Request + +# 1.1. Automatic Start + +After completing the preparatory stage of creating a Pull Request with the AI reviewer added, the code review **will be launched automatically.** + +# 1.2. Manual Start + +If for some reason you need to start the review yourself, use the `@kodobot` tag when writing a comment in the pull request. + +# 2. Code review prevention + +To prevent the review from starting, we can use the following methods + +## 2.1. Tag [no ai] in the pull request title + +When a pull request is created with the tag `[no ai]` in the pull request title, and when new changes are pushed to the pull request, the reviewer will not be triggered for that pull request. +This can be useful if you use `CODEOWNERS` file in your repository. + +## 2.2. Do not add AI use to PR + +You can choose not to add the `@kodobot` AI Reviewer user at all, and then the kodo review tool will never run for this Pull Request. + +⚠️ **Important:** you **do not need** to write the `[no ai]` tag if no AI user has been added to the Pull Request for review. + +## 3. Questions for AI + +You can use the `@kodobot` tag in a Pull Request comment to ask the AI anything. After adding the `@kodobot` tag to your message you will receive a response from AI user. +