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.

Sign up for GitHub

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

fix: add extra instructions for the pr review agent to make sure the code being tested is not mocked out #62

Merged
merged 2 commits into from
Mar 17, 2025
Merged

fix: add extra instructions for the pr review agent to make sure the code being tested is not mocked out #62

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e39e622
fix: add extra instructions for the pr review agent to make sure the …
shanejonas Mar 17, 2025
29f8552
fix: add
shanejonas Mar 17, 2025
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
13 changes: 11 additions & 2 deletions .github/workflows/reusable-node-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,17 @@ jobs:
pr_reviewer.inline_code_comments: "true"
pr_description.publish_description_as_comment: "false"
pr_description.add_original_user_description: "true"
# pr_reviewer.extra_instructions: "- instruction a\n- instruction b\n..."

pr_reviewer.extra_instructions: |
## Reviewer Instructions
### General
- In general if there is a PR that requires updating any versions of `@shardeum` packages, ensure those changes are in an separate PR (or in the same PR in its own commit). Otherwise, merging between branch lines (which have different versions) is much more difficult.
### Unit Tests
- Ensure that external API calls or side effects are mocked out, not the function under test
- Each test should import the actual function being tested
- Mock only external dependencies, never the function itself
- Make sure tests cover real functionality, not only type definitions
- `expect()` syntax should be used instead of `assert()`
- If a test is using mocks, ensure its cleaned up after the test
merge-checks:
name: QA merge checks
runs-on: ubuntu-latest
Expand Down
Loading