Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve the example prompt #5

Merged
merged 1 commit into from
Apr 3, 2024
Merged

chore: improve the example prompt #5

merged 1 commit into from
Apr 3, 2024

Conversation

idubnori
Copy link
Owner

@idubnori idubnori commented Apr 3, 2024

Type

enhancement


Description

  • .github/workflows/pr-agent.ymlREADME.mdの環境変数の指示を更新しました。
  • 「日本語で回答してください」という新しい指示を追加しました。
  • テストコードの追加やアプリケーションコードの変更に焦点を当てるように指示を変更しました。

Changes walkthrough

Relevant files
Enhancement
pr-agent.yml
PR-Agentのワークフロー設定の更新                                                                         

.github/workflows/pr-agent.yml

  • .github/workflows/pr-agent.ymlの環境変数の指示を更新しました。
  • 「日本語で回答してください」という指示を追加しました。
  • テストコードの追加やアプリケーションコードの変更に焦点を当てるように指示を変更しました。
  • +3/-3     
    README.md
    READMEの環境変数指示の更新                                                                                 

    README.md

  • README.mdの環境変数の指示を更新しました。
  • 「日本語で回答してください」という指示を追加しました。
  • テストコードの追加やアプリケーションコードの変更に焦点を当てるように指示を変更しました。
  • +3/-3     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 3, 2024
    Copy link

    github-actions bot commented Apr 3, 2024

    PR Description updated to latest commit (0f9d5e5)

    Copy link

    github-actions bot commented Apr 3, 2024

    PR Review

    (Review updated until commit 4881584)

    ⏱️ Estimated effort to review [1-5]

    2, このPRは主に設定ファイルとドキュメントの更新を含んでおり、変更の規模が小さく、理解しやすいためです。

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:
    relevant file.github/workflows/pr-agent.yml
    suggestion      

    環境変数の更新に伴い、関連するドキュメントやコメントも更新することをお勧めします。これにより、将来のメンテナンスが容易になります。 [medium]

    relevant line- Answer in Japanese.

    relevant fileREADME.md
    suggestion      

    README.mdの変更により、ユーザーが新しい指示をより明確に理解できるようになりましたが、具体的な使用例を追加することで、さらに理解を深めることができます。 [medium]

    relevant line- Answer in Japanese.


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    @github-actions github-actions bot added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Apr 3, 2024
    Repository owner deleted a comment from github-actions bot Apr 3, 2024
    Repository owner deleted a comment from github-actions bot Apr 3, 2024
    Repository owner deleted a comment from github-actions bot Apr 3, 2024
    Repository owner deleted a comment from github-actions bot Apr 3, 2024
    @idubnori idubnori closed this Apr 3, 2024
    @idubnori idubnori reopened this Apr 3, 2024
    Copy link

    github-actions bot commented Apr 3, 2024

    PR Description updated to latest commit (4881584)

    Copy link

    github-actions bot commented Apr 3, 2024

    Persistent review updated to latest commit 4881584

    Copy link

    github-actions bot commented Apr 3, 2024

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    envセクション内の指示文言をより明確にする。


    YAMLファイル内のenvセクションで、common_instructionspr_reviewer.extra_instructionsの文言を改善することを提案します。現在の文言は少し曖昧で、より具体的な指示に変更することで、PRレビュアーが求められているアクションをより明確に理解できるようになります。

    .github/workflows/pr-agent.yml [18-21]

     common_instructions: >-
    -  - Answer in Japanese.
    +  - レビューは日本語で行ってください。
     pr_reviewer.extra_instructions: >-
    -  - Additional second priority point: focus on the need for test code additions or changes to the application code changes.
    +  - 第二の優先事項として、テストコードの追加やアプリケーションコードの変更に焦点を当ててください。
     
    README.mdのenvセクション内の指示文言をより具体的にする。


    README.mdファイル内のenvセクションで、common_instructionspr_reviewer.extra_instructionsの文言を改善することを提案します。具体的な指示により、コントリビューターが求められているアクションをより明確に理解できるようになります。

    README.md [36-39]

     common_instructions: >-
    -  - Answer in Japanese.
    +  - レビューは日本語で行ってください。
     pr_reviewer.extra_instructions: >-
    -  - Additional second priority point: focus on the need for test code additions or changes to the application code changes.
    +  - 第二の優先事項として、テストコードの追加やアプリケーションコードの変更に焦点を当ててください。
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    @idubnori idubnori merged commit ec54b5f into main Apr 3, 2024
    1 check passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant