Skip to content

[DO NOT MERGE TO MAIN] docs: split repo-specific vs general instructions#72

Merged
is0692vs merged 3 commits intomainfrom
docs/reference-pr-consolidation-playbook
Mar 14, 2026
Merged

[DO NOT MERGE TO MAIN] docs: split repo-specific vs general instructions#72
is0692vs merged 3 commits intomainfrom
docs/reference-pr-consolidation-playbook

Conversation

@is0692vs
Copy link
Contributor

DO NOT MERGE TO MAIN

This is a reference-only PR for instruction wording. Keep it out of main unless we later decide to adopt this split and workflow wording intentionally.

What changed

  • Split .github/copilot-instructions.md into two explicit halves:
    • Part 1: project-specific repository knowledge
    • Part 2: general agent workflow playbooks
  • Added a reusable PR Consolidation Playbook section covering:
    • choosing one destination PR
    • merging similar PRs into that destination
    • carrying forward valid review feedback from source PRs
    • updating the surviving PR title/body as a consolidated PR
    • commenting on and closing superseded PRs
    • rerunning the post-push sleep 300 && gh pr checks "$PR_URL" loop after every destination-branch push
  • Added an explicit note that generic workflow wording being iterated in a reference PR should not be merged to main by default

Why this is separate

The repository-specific facts are useful in main, but the generalized workflow playbook is broader and should be reviewed as a reference pattern first.

@vercel
Copy link

vercel bot commented Mar 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
github-user-summary Ready Ready Preview, Comment Mar 14, 2026 2:03pm

@coderabbitai
Copy link

coderabbitai bot commented Mar 14, 2026

Warning

Rate limit exceeded

@is0692vs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 4 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6851def9-4eba-4d66-92a1-5520c1471b25

📥 Commits

Reviewing files that changed from the base of the PR and between e051547 and 069fde3.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/reference-pr-consolidation-playbook
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the copilot-instructions.md documentation to provide a clearer separation between repository-specific operational details and broader, reusable agent workflow guidelines. The primary goal is to enhance the clarity and organization of instructions, making it easier for contributors to understand both project-specific practices and general development workflows, such as a detailed PR consolidation strategy. This PR is intended for reference and discussion, not for direct merge into main.

Highlights

  • Documentation Structure: The copilot-instructions.md file was split into two distinct sections: "Part 1: Project-Specific Context" and "Part 2: General Agent Workflow Playbooks" to improve organization.
  • PR Consolidation Playbook: A new comprehensive guide for consolidating multiple overlapping pull requests into a single destination PR was added, outlining steps for merging, review handling, and hygiene.
  • Workflow Iteration Note: An explicit disclaimer was included, stating that generic workflow wording iterated in reference PRs should not be merged to main by default.
Changelog
  • .github/copilot-instructions.md
    • Separated content into "Part 1: Project-Specific Context" and "Part 2: General Agent Workflow Playbooks".
    • Updated heading levels for improved hierarchy and readability.
    • Relocated "Useful Paths & Entry Points" and "Common Tasks" to the project-specific section.
    • Introduced a new "PR Consolidation Playbook" detailing steps for merging overlapping PRs.
    • Modified existing sections like "Starting New Work" and "Validation Before Push" for clarity and moved the latter to Part 2.
    • Renamed several headings for better descriptive accuracy, such as "CI Check Loop" and "Responding to PR Reviews".
    • Removed the "CI Expectations" and "Notes for Agents" sections.
    • Added a "Final Checklist" to conclude the document.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request does a great job of restructuring the agent instructions by splitting them into project-specific context and general workflow playbooks. The addition of the PR Consolidation Playbook is a valuable enhancement. The overall changes significantly improve the clarity and organization of the document. I have one minor suggestion to improve the clarity of a command in the new consolidation playbook.

@is0692vs is0692vs marked this pull request as ready for review March 14, 2026 13:51
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/copilot-instructions.md:
- Around line 213-220: Add a prominent one-line "Reference-only" warning at the
top of the "Part 2: General Agent Workflow Playbooks" section to make it obvious
this content is not intended as permanent repo policy; update the heading block
in .github/copilot-instructions.md (the "Part 2: General Agent Workflow
Playbooks" section) to prepend a short, bold or all-caps notice like
"REFERENCE-ONLY: Do not merge into main as a policy" and ensure the existing
paragraph about marking reference PRs remains unchanged and clearly referenced
from that warning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c1699caa-3c5e-4ffb-8d28-375596cf4cec

📥 Commits

Reviewing files that changed from the base of the PR and between ece22a0 and e051547.

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

@is0692vs is0692vs closed this Mar 14, 2026
@is0692vs is0692vs reopened this Mar 14, 2026
@is0692vs is0692vs merged commit 328d1fb into main Mar 14, 2026
7 checks passed
@is0692vs is0692vs deleted the docs/reference-pr-consolidation-playbook branch March 14, 2026 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant