Skip to content

Update copilot instructions for PR checks and CI#552

Merged
rjmurillo merged 13 commits intomainfrom
copilot/fix-500
Jul 19, 2025
Merged

Update copilot instructions for PR checks and CI#552
rjmurillo merged 13 commits intomainfrom
copilot/fix-500

Conversation

@rjmurillo
Copy link
Copy Markdown
Owner

@rjmurillo rjmurillo commented Jul 19, 2025

Summary by CodeRabbit

  • Documentation
    • Updated contributor instructions with a new section outlining required local checks and CI requirements for pull requests, including formatting, build, tests, Codacy analysis, and documentation of results. Clarified that PRs failing these checks will not be reviewed.

Copilot AI and others added 13 commits June 18, 2025 09:59
Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
…e tests

Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Enhance documentation for null type syntax scenarios with detailed explanations
- Add curly braces around nested if statement for better code style
- Explain when parameter type inference occurs and why returning true is correct

Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
Co-authored-by: rjmurillo <6811113+rjmurillo@users.noreply.github.com>
- Enhance CallbackSignatureShouldMatchMockedMethodAnalyzer to robustly check ref/out/in modifiers and parameter types.
- Update CallbackSignatureShouldMatchMockedMethodFixer to preserve ref/out/in modifiers in code fixes.
- Expand RefOutCallbackTests to cover edge cases and verify correct
Added a dedicated section outlining mandatory formatting, build, test, and Codacy analysis checks for all PRs.
Clarified evidence requirements and CI enforcement.
Linked recent PR and CI job examples for reference.
Copilot AI review requested due to automatic review settings July 19, 2025 17:36
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 19, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A new section outlining mandatory PR checks and CI requirements was added to the contributor instructions in .github/copilot-instructions.md. This update details required local checks, documentation of results in PR descriptions, and clarifies that PRs failing any check will not be reviewed or merged.

Changes

File(s) Change Summary
.github/copilot-instructions.md Added a section specifying required local checks, CI mandates, evidence submission, and PR closure rules

Possibly related PRs

Suggested labels

documentation, releasable

Suggested reviewers

  • MattKotsenas

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e81f2d and 43b847b.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md (1 hunks)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the Copilot instructions to add comprehensive PR checks and CI requirements. The update emphasizes strict validation requirements that must be met before code review.

  • Adds detailed PR validation checklist including formatting, build, test, and analysis requirements
  • Specifies evidence requirements for PR descriptions with console output or screenshots
  • Establishes clear consequences for PRs that fail validation (automatic closure)

`dotnet test --settings ./build/targets/tests/test.runsettings`
All tests must pass. PRs with failing tests will be closed.
- **Codacy Analysis:**
Run Codacy CLI analysis on all changed files. Fix all reported issues before submitting the PR.
Copy link

Copilot AI Jul 19, 2025

Choose a reason for hiding this comment

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

The Codacy Analysis section lacks specific instructions on how to run the CLI analysis. Consider adding the exact command or referencing where developers can find the instructions.

Suggested change
Run Codacy CLI analysis on all changed files. Fix all reported issues before submitting the PR.
Run Codacy CLI analysis on all changed files using the following command:
`codacy-analysis-cli analyze --directory <path-to-changed-files>`
Replace `<path-to-changed-files>` with the directory containing the modified files.
For more details, refer to the [Codacy CLI documentation](https://docs.codacy.com/repositories-configure/codacy-analysis-cli/).
Fix all reported issues before submitting the PR.

Copilot uses AI. Check for mistakes.
- **No Received Files:**
Remove any `*.received.*` files before committing.
- **Moq Version Awareness:**
If tests are added/changed, specify which Moq versions are targeted and how test data is grouped.
Copy link

Copilot AI Jul 19, 2025

Choose a reason for hiding this comment

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

The Moq Version Awareness requirement is vague. It doesn't specify how developers should document version targeting or what constitutes proper test data grouping documentation.

Suggested change
If tests are added/changed, specify which Moq versions are targeted and how test data is grouped.
If tests are added/changed, document the following in the PR description:
- The specific Moq version(s) targeted by the tests.
- A brief explanation of how test data is grouped, including the rationale for the grouping strategy.
Ensure this information is clear and concise to assist reviewers in understanding the changes.

Copilot uses AI. Check for mistakes.
@rjmurillo rjmurillo merged commit 6d14bd1 into main Jul 19, 2025
11 of 13 checks passed
@rjmurillo rjmurillo deleted the copilot/fix-500 branch July 19, 2025 17:37
@rjmurillo rjmurillo added this to the vNext milestone Jul 19, 2025
@codacy-production
Copy link
Copy Markdown

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) (target: 95.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (4e81f2d) 1696 1527 90.04%
Head commit (43b847b) 1696 (+0) 1527 (+0) 90.04% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#552) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants