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

Update readme to include a demo #9

Merged
merged 2 commits into from
May 11, 2023
Merged

Update readme to include a demo #9

merged 2 commits into from
May 11, 2023

Conversation

johnlk
Copy link
Contributor

@johnlk johnlk commented May 11, 2023

No description provided.

@johnlk johnlk self-assigned this May 11, 2023
@github-actions
Copy link

Thanks for the pull request code submission! Here's my feedback:

Letter grade: B

Improvements:

  1. Update image source URL to include "/assets" to ensure that it will load correctly regardless of file directory location.
  2. Add more information in the README about what the project does and how to use it.
  3. Add links to relevant documentation and resources to make it easier for users to understand and use the project.

Code block:

# Robin AI

<img src="/assets/robin.png" alt="Robin watercolor image" style="width: 200px; height: 200px;"/>

Named after Batman's assistant, Robin AI is an open source Github project that automatically reviews Github pull requests, providing a letter grade from A to F, suggested improvements, and sample code for improvement.

## Demo

Check out this [demo video](/assets/demo.gif) to see Robin AI in action!

## Getting Started

To use Robin AI, simply add it as a Github action to your project's workflow. Make sure to provide the required `GITHUB_TOKEN` and `OPEN_AI_API_KEY` parameters. Read more about how to implement Robin AI in your project in the [documentation](/docs).

We hope that Robin AI can help improve code quality across Github projects, and we welcome any feedback on how to make it even better!

Please let me know if you have any questions!

@johnlk johnlk merged commit 248d755 into main May 11, 2023
1 check passed
@github-actions
Copy link

Thank you for the pull request! Here's my feedback:

Letter Grade: B

Improvements:

  1. Use relative path for the Robin image source. Not everyone has a folder called "assets" in the root directory of their project, and using a relative path would make this code more portable.
  2. Add more details to the README. Currently, it only explains what the project is and how to set it up, but it doesn't say anything about what it does or how it's useful. Adding more details would be helpful for potential users.
  3. Consider adding a license file. As an open source project, it's important to specify what license this code is under.

Code Example:

# Robin AI

![Robin watercolor image](./assets/robin.png | width=200)

Named after Batman's assistant, Robin AI is an open source Github project that automatically reviews Github pull requests, providing a letter grade from A to F, suggested improvements, and sample code for improvement.

## Demo

![Demo video](./assets/demo.gif)

This demo shows how Robin AI works in action.

## How it Works

Robin AI is a Github action that can be set up to automatically review pull requests. After a pull request is opened, Robin AI reviews the code changes and provides a letter grade, suggested improvements, and sample code for improvement. This makes it easy for developers to identify areas where their code can be improved and learn how to make those improvements.

## Getting Started

To get started using Robin AI, you'll need to set up the Github action in your repository. The action requires two parameters: `GITHUB_TOKEN`, which is automatically supplied by Github for the user, and `OPEN_AI_API_KEY`, which is an API key from Open AI's developer portal.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

@johnlk johnlk deleted the john/readme-demo branch May 11, 2023 00:06
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.

None yet

1 participant