-
Notifications
You must be signed in to change notification settings - Fork 14
Add an AI review skill to guide users #168
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
Open
ahuang11
wants to merge
6
commits into
MarcSkovMadsen:main
Choose a base branch
from
ahuang11:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3936d9e
Rename AI Review to Review
ahuang11 b35cef6
Couple other reminders
ahuang11 84740ed
Update skills/review/SKILL.md
ahuang11 9178552
Apply suggestion from @ahuang11
ahuang11 9f59338
Apply suggestions from code review
ahuang11 33a42f2
Update skills/review/SKILL.md
ahuang11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Review | ||
|
|
||
| ## Purpose | ||
| Perform a `git diff` from the PR branch to the main branch, and review the code changes for potential issues, improvements, and adherence to best practices. Then provide a plan, pointing to lines of code and modules for refactoring the code to improve its quality, readability, and maintainability. | ||
|
|
||
| ## Checklist | ||
| - [ ] when the attribute is known to be present, do not use `hasattr` & `getattr` | ||
| - [ ] use try/except only on the clause that may raise the exception, not on the whole function | ||
| - [ ] try to pin the exception type in the except clause, do not use a bare except | ||
| - [ ] return or continue early to avoid deep nesting | ||
| - [ ] anything over 3 levels of nesting should be refactored into helper functions | ||
| - [ ] imports should be at the top of the file, not inside functions unless there is a specific reason to do so (slow import, circular import, etc.) | ||
| - [ ] understanding the full changes, is there a more efficient or cleaner way to achieve the same result? | ||
| - [ ] consistent and readable naming conventions, e.g. if `ExampleClass` is used, the variable name should be `example_class`, not `exampleclass` or `example_classes` (plural) | ||
| - [ ] if necessary, ensure the feature or enhancement documented in the docs | ||
| - [ ] avoid implicit boolean checks on pandas objects, e.g. `if df`, `if df == obj`, etc | ||
|
ahuang11 marked this conversation as resolved.
Outdated
ahuang11 marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.