From 1a7a272d083135b6beb08c44a63ea2c27ef21c27 Mon Sep 17 00:00:00 2001 From: bobo Date: Fri, 19 Jul 2024 10:56:46 +0800 Subject: [PATCH 1/2] feat: Add README files and update PR command structure - Add README.md for PR command and its subcommands - Update command.yml files to include help references - Modify requirements.txt to use pr_env branch - Add configuration options for PR inline review --- merico/pr/README.md | 34 ++++++++++++++++++++++++ merico/pr/command.yml | 3 ++- merico/pr/config/README.md | 24 +++++++++++++++++ merico/pr/config/command.yml | 1 + merico/pr/custom_suggestions/command.yml | 1 + merico/pr/describe/command.yml | 1 + merico/pr/requirements.txt | 2 +- merico/pr/review/command.yml | 1 + 8 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 merico/pr/README.md create mode 100644 merico/pr/config/README.md diff --git a/merico/pr/README.md b/merico/pr/README.md new file mode 100644 index 0000000..f42b3b4 --- /dev/null +++ b/merico/pr/README.md @@ -0,0 +1,34 @@ +# pr 命令 + +pr命令是一个用于处理Pull Requests (PRs)的主命令。它本身不执行具体操作，而是通过子命令来完成特定功能。 + +## 可用子命令 + +1. pr.review - 生成PR代码评审描述 +2. pr.improve - 生成PR的代码建议 +3. pr.describe - 生成PR描述 +4. pr.custom_suggestions - 生成PR的自定义代码建议 + +## 使用方法 + +要使用pr命令的功能，请使用以下格式调用相应的子命令： + +/pr.<子命令> + +例如： +- /pr.review https://github.com/devchat-ai/devchat/pull/301 +- /pr.improve https://github.com/devchat-ai/devchat/pull/301 +- /pr.describe https://github.com/devchat-ai/devchat/pull/301 +- /pr.custom_suggestions https://github.com/devchat-ai/devchat/pull/301 + +## 子命令说明 + +1. pr.review: 分析PR并生成代码评审描述，帮助审阅者快速了解PR的内容和影响。 + +2. pr.improve: 分析PR并提供代码改进建议，帮助开发者优化其代码。 + +3. pr.describe: 自动生成PR的描述，总结PR的主要变更和目的。 + +4. pr.custom_suggestions: 根据特定需求生成自定义的PR代码建议。 + +请根据您的具体需求选择适当的子命令。每个子命令都专注于PR处理的不同方面，帮助您更高效地管理和改进Pull Requests。 \ No newline at end of file diff --git a/merico/pr/command.yml b/merico/pr/command.yml index a3e68b1..9debc24 100644 --- a/merico/pr/command.yml +++ b/merico/pr/command.yml @@ -2,4 +2,5 @@ description: "pr command" workflow_python: env_name: devchat-pr-env4 version: 3.11.0 - dependencies: requirements.txt \ No newline at end of file + dependencies: requirements.txt +help: README.md \ No newline at end of file diff --git a/merico/pr/config/README.md b/merico/pr/config/README.md new file mode 100644 index 0000000..d5e5c57 --- /dev/null +++ b/merico/pr/config/README.md @@ -0,0 +1,24 @@ +# pr.config + +**/pr.config命令用于配置Git工作流所需的设置。** + + +该命令允许用户配置以下选项: + +1. PR Review Inline: 启用或禁用PR内联评审功能。 + +使用方式: +直接运行 /pr.config 命令,无需额外参数。 + +命令会引导用户通过交互式界面进行配置。用户可以选择是否启用PR内联评审功能。 + + +配置文件位置: +全局配置文件保存在用户主目录下的 ~/.chat/.workflow_config.json + + +注意: +- 如需修改访问令牌或主机URL,请直接编辑配置文件。 +- 配置更改后会立即生效。 + +这个命令可以帮助用户快速设置Git工作流所需的重要配置项,提高使用效率。 \ No newline at end of file diff --git a/merico/pr/config/command.yml b/merico/pr/config/command.yml index dd639bf..827ab03 100644 --- a/merico/pr/config/command.yml +++ b/merico/pr/config/command.yml @@ -1,3 +1,4 @@ description: 'Config required settings for GIT workflows.' +help: README.md steps: - run: $devchat_python $command_path/command.py \ No newline at end of file diff --git a/merico/pr/custom_suggestions/command.yml b/merico/pr/custom_suggestions/command.yml index 595d851..39a5333 100644 --- a/merico/pr/custom_suggestions/command.yml +++ b/merico/pr/custom_suggestions/command.yml @@ -1,4 +1,5 @@ description: "review pr" input: required +help: README.md steps: - run: $workflow_python $command_path/../command.py "$input" custom_suggestions \ No newline at end of file diff --git a/merico/pr/describe/command.yml b/merico/pr/describe/command.yml index 3f9fbb7..a5f7d63 100644 --- a/merico/pr/describe/command.yml +++ b/merico/pr/describe/command.yml @@ -1,4 +1,5 @@ description: "review pr" input: required +help: README.md steps: - run: $workflow_python $command_path/../command.py "$input" describe \ No newline at end of file diff --git a/merico/pr/requirements.txt b/merico/pr/requirements.txt index 74cf8a8..c9ba810 100644 --- a/merico/pr/requirements.txt +++ b/merico/pr/requirements.txt @@ -1,2 +1,2 @@ git+https://gitee.com/imlaji/pr-agent.git@ad276e206c7e462a689996ee3ada2769b35d5625 -git+https://gitee.com/devchat-ai/devchat.git@main +git+https://gitee.com/devchat-ai/devchat.git@pr_env diff --git a/merico/pr/review/command.yml b/merico/pr/review/command.yml index aed7a35..296ed9e 100644 --- a/merico/pr/review/command.yml +++ b/merico/pr/review/command.yml @@ -1,4 +1,5 @@ description: "review pr" input: required +help: README.md steps: - run: $workflow_python $command_path/../command.py "$input" review \ No newline at end of file From e03d1eb5ddd7849bd4376af5d4a94990066803da Mon Sep 17 00:00:00 2001 From: bobo Date: Fri, 19 Jul 2024 11:05:37 +0800 Subject: [PATCH 2/2] docs: Add README for commit command and update YAML - Add README.md explaining usage and steps of commit command - Include optional issue closing feature in README - Update command.yml to reference new README.md for help --- merico/commit/README.md | 30 ++++++++++++++++++++++++++++++ merico/commit/command.yml | 1 + 2 files changed, 31 insertions(+) create mode 100644 merico/commit/README.md diff --git a/merico/commit/README.md b/merico/commit/README.md new file mode 100644 index 0000000..8cc0c72 --- /dev/null +++ b/merico/commit/README.md @@ -0,0 +1,30 @@ +# Commit 命令 + +该命令用于为选中的代码更改编写格式良好的提交信息,并通过Git提交这些更改。 + +## 用法 +/commit [to close #issue_number] + + +## 说明 + +- 该命令会引导你完成以下步骤: + +1. 选择要包含在本次提交中的修改文件 +2. 查看并编辑AI生成的提交信息 +3. 确认并执行Git提交 + +- 你可以选择性地在命令中包含要关闭的issue编号,例如: + +/commit to close #12 + + +- 如果不指定issue编号,命令仍会正常执行,只是不会在提交信息中包含关闭issue的引用。 + +- 该命令会调用Git来执行实际的提交操作,因此请确保你的系统中已正确安装并配置了Git。 + +## 提示 + +- 在执行该命令之前,请确保你已经对要提交的文件进行了必要的修改。 +- 仔细检查AI生成的提交信息,并根据需要进行编辑,以确保信息准确反映了你的更改。 +- 养成经常小批量提交的好习惯,这有助于更好地跟踪项目历史。 \ No newline at end of file diff --git a/merico/commit/command.yml b/merico/commit/command.yml index 84646f7..60429ab 100644 --- a/merico/commit/command.yml +++ b/merico/commit/command.yml @@ -1,5 +1,6 @@ description: 'Writes a well-formatted commit message for selected code changes and commits them via Git. Include an issue number if desired (e.g., input "/commit to close #12").' hint: to close Issue #issue_number input: optional +help: README.md steps: - run: $devchat_python $command_path/commit.py "$input" \ No newline at end of file