Skip to content

Standardized organization repository guidance - #28

Open
CTristan wants to merge 2 commits into
mainfrom
docs/add-contributor-guidance
Open

Standardized organization repository guidance#28
CTristan wants to merge 2 commits into
mainfrom
docs/add-contributor-guidance

Conversation

@CTristan

@CTristan CTristan commented Aug 2, 2026

Copy link
Copy Markdown
Member

Adds root repository guidance for organization defaults, reusable workflows, templates, and validation. The README.md and CONTRIBUTING.md now own the human-maintained instructions, while the thin AGENTS.md points work to those sources. This also removes the obsolete Copilot guide so we only have one authority. Checks covered actionlint, Markdown links, and a fresh repository-root guidance load.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fe458db5-b118-41b1-b7bf-af181bac78c2

📥 Commits

Reviewing files that changed from the base of the PR and between fff7310 and 30fad92.

📒 Files selected for processing (1)
  • AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • AGENTS.md

Summary by CodeRabbit

  • Documentation
    • Added contribution guidelines covering repository structure, validation requirements, workflow usage, and pull-request expectations.
    • Expanded repository guidance with details about shared configuration, reusable workflows, file precedence, and contribution practices.
    • Added instructions for reviewing key documentation before making changes.
    • Removed outdated repository guidance documentation and replaced it with clearer, consolidated information about repository processes and shared configuration.

Walkthrough

The change removes the Copilot instructions file and adds repository guidance. README.md, CONTRIBUTING.md, and AGENTS.md document repository structure, contribution rules, workflow contracts, validation, and authoritative sources.

Changes

Repository guidance

Layer / File(s) Summary
Repository overview and guidance
README.md, AGENTS.md
README.md describes shared GitHub configuration and file precedence. AGENTS.md identifies README.md and CONTRIBUTING.md as authoritative sources.
Contribution contract
CONTRIBUTING.md
Contribution guidance covers workflow compatibility, secret handling, inheritance, validation, and pull-request requirements.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A rabbit reads the repo with care,
Finds workflow rules neatly there.
README points the way,
CONTRIBUTING holds the day,
And AGENTS keeps guidance fair.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the repository guidance standardization described in the changeset.
Description check ✅ Passed The description directly explains the new repository guidance, authoritative documents, removed guide, and validation covered by the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-contributor-guidance
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/add-contributor-guidance

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

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.

1 participant