Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions .github/workflows/ai-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,19 @@ jobs:
- uses: SAP/ai-assisted-github-actions/pr-review@v3
with:
aicore-service-key: ${{ secrets.AICORE_SERVICE_KEY }}
model: anthropic--claude-4-sonnet
show-model-metadata-footer: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'show-model-metadata-footer' is enabled to increase transparency.

Note that the underlying LLMs may undergo updates and will evolve over time. Responses may vary between different model versions, even when using the same model.

model: mistralai--mistral-medium-instruct
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you consider aligning the model parameters between the changes? For example, including the temperature parameter.

model-parameters: '{"temperature": 0.1}'
prompt: |
- As an AI bot reviewing documentation pull requests on GitHub, please focus on the following areas to ensure high-quality and effective documentation:
- Use U.S. English spelling and punctuation.
- Check for spelling errors and provide corrections.
- Identify and correct grammatical errors and incorrect punctuation.
- Provide suggestions for improving the clarity and conciseness of the text to make it more understandable. Use the comments to create real suggestions and include all proposals that target the same line into one suggestions. Do not create multiple suggestions for the same line or paragraph.
- Consider the guidelines that can be found in .github/workflows/assets/editor.md and apply them.
Comment on lines 27 to 32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt block has inconsistent list formatting and a stray comment indentation. Ensure the prompt content uses consistent bullet markers and indentation so the model receives a clear instruction list. Also keep instructions concise, use active voice, and require present tense (as your developer guidance specifies). Consolidate references to the editor guidelines into a single, clear bullet. Suggested replacement for the prompt block content (preserve the YAML multiline pipe '|' and the same indentation level used for other 'with' keys):

  • As an AI bot reviewing documentation pull requests on GitHub, focus on these areas to ensure high-quality, effective documentation:
    • Use U.S. English spelling and punctuation.
    • Check for spelling errors and provide corrections.
    • Identify and correct grammatical errors and incorrect punctuation.
    • Refer to .github/workflows/assets/editor.md and apply its guidelines.
    • Provide suggestions to improve clarity and conciseness. Use the comments feature to create actionable suggestions and include all proposals targeting the same line in a single suggestion. Do not create multiple suggestions for the same line or paragraph.
    • Ensure the tone suits technical documentation: professional and informative.
    • Verify that the document structure is logical and headings and subheadings are effective.
    • Check for consistent terminology and style throughout the document.
    • Use active voice and present tense; avoid future tense.

Make sure each bullet line starts with a single '- ' (dash + space) and that indentation is consistent across the prompt block. Remove any extraneous leading hyphens or uneven spacing.

As an AI bot reviewing documentation pull requests on GitHub, please focus on the following areas to ensure high-quality and effective documentation.
- Refer to .github/workflows/assets/editor.md and apply its guidelines.
- Provide inline suggestions and include all proposals that target the same line into one suggestion.
- Do not create multiple suggestions for the same line or paragraph.
- Do not create suggestions on deleted lines.
- Ensure that the tone is appropriate for technical documentation, maintaining a professional and informative style.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed the guideline reference to the editor rules file. If those guidelines are relevant to reviewers, reintroduce a concise reference so reviewers follow the project's style. Suggested insertion after the paragraph above:

  • Refer to .github/workflows/assets/editor.md and apply its guidelines.

Comment on lines +28 to 33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt should be consistent in style and tone. Consider revising the bullet points to match the rest of the document. For example:

  • Refer to .github/workflows/assets/editor.md and apply its guidelines.
  • Provide inline suggestions and include all proposals that target the same line into one suggestion.
  • Do not create multiple suggestions for the same line or paragraph.
  • Do not create suggestions on deleted lines.

Comment on lines +28 to 33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt should be consistent in style and tone. Consider revising the bullet points to match the rest of the document. For example:

  • Refer to .github/workflows/assets/editor.md and apply its guidelines.
  • Provide inline suggestions and include all proposals that target the same line into one suggestion.
  • Do not create multiple suggestions for the same line or paragraph.
  • Do not create suggestions on deleted lines.

Comment on lines +28 to 33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt should be consistent in style and tone. Consider revising the bullet points to match the rest of the document. For example:

  • Refer to .github/workflows/assets/editor.md and apply its guidelines.
  • Provide inline suggestions and include all proposals that target the same line into one suggestion.
  • Do not create multiple suggestions for the same line or paragraph.
  • Do not create suggestions on deleted lines.

Comment on lines +28 to 33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt should be consistent in style and tone. Consider revising the bullet points to match the rest of the document. For example:

  • Refer to .github/workflows/assets/editor.md and apply its guidelines.
  • Provide inline suggestions and include all proposals that target the same line into one suggestion.
  • Do not create multiple suggestions for the same line or paragraph.
  • Do not create suggestions on deleted lines.

- Verify that the structure of the document is logical and that headings and subheadings are used effectively.
- Check for consistency in terminology and style throughout the document.
- Use active voice instead of passive voice
- Use present tense and **avoid future tense**!
header-text: |
# AI-Assisted Review
This pull request has been reviewed by an AI bot to ensure high-quality documentation. The review focuses on improving the clarity, accuracy, and overall quality of the documentation while adhering to established guidelines.

Comment on lines 21 to 39
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prompt has been improved for clarity and conciseness. The changes ensure that the guidelines are more straightforward and easier to follow. The addition of the header-text section provides a clear introduction to the AI-assisted review process.

Loading
Loading