Skip to content

Update README.md for ease of use - #36

Open
CheriseCodes wants to merge 3 commits into
villesau:mainfrom
CheriseCodes:patch-1
Open

Update README.md for ease of use#36
CheriseCodes wants to merge 3 commits into
villesau:mainfrom
CheriseCodes:patch-1

Conversation

@CheriseCodes

Copy link
Copy Markdown

Update description to make the action easier to use and avoid confusion

Update description to make the action easier to use and avoid confusion
Correct readme to communicate that forking the repository is required for the workflow to work
Comment thread README.md
information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets).

3. Create a `.github/workflows/main.yml` file in your repository and add the following content:
3. Fork this repository to your account or organization

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Forking is not needed, this action is available in the marketplace too: https://github.com/marketplace/actions/ai-code-review-action

Comment thread README.md

- name: AI Code Reviewer
uses: your-username/ai-code-reviewer@main
uses: your-username/ai-codereviewer@main

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

This works too: freeedcom/ai-codereviewer@v2.7.0

@1ron

1ron commented Oct 16, 2024

Copy link
Copy Markdown

@CodiumAI-Agent /review

@QodoAI-Agent

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants