This repository was archived by the owner on May 24, 2026. It is now read-only.
Add contributor workflow docs#56
Draft
Xelvanis wants to merge 4 commits into
Draft
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
13 tasks
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Linked Issue
No linked issue; this PR adapts contributor workflow docs and PR preparation guidance for ME-Refactor.
Why This Change
Owner And Impact
What Changed
CONTRIBUTING.mdfor ME-Refactor setup, branch flow, architecture ownership, AI-assisted contribution rules, validation, PR expectations, and release/version notes..github/pull_request_template.mdwith owner/impact fields, free-text architecture notes, validation prompts, and explicit agent checkbox guidance.README.md.pnpm check:docsto require the contributor guide and PR template, catch stale legacy terms, and enforce the current PR template headings/check guidance.pnpm check:architectureto contributor validation guidance for import boundaries, layered ownership, shared modules, Rust command structure, and architecture-sensitive refactors.Architecture Notes
Docs/workflow-only change. No runtime architecture boundary changed.
The PR template now uses free-text architecture notes instead of an
Architecture And AI-Assisted Reviewcheckbox block, because agent-ticked architecture boxes are not proof and human-ticked boxes are weaker than concrete owner/impact notes plus targeted validation.Validation
pnpm check:architecturepasses locally, if imports, file layout, feature boundaries, engine layers, shared APIs, or Rust command structure changedpnpm typecheckpasses locallypnpm check:rustpasses locallypnpm check:docspasses locallypnpm buildpasses locally, if imports, bundling, or runtime UI paths changedpnpm checkpasses locally, if this PR is ready for broad evaluationCONTRIBUTING.md,AGENTS.md, and the relevantdocs/developer/pagesManual Verification Notes
pnpm check:docspassed after the contributor workflow and PR template revisions.git diff --checkwas clean aside from normal Windows line-ending notices.Docs And Release Impact
Docs changed: adds
CONTRIBUTING.md,.github/pull_request_template.md, and README contributor linkage. No changelog/release note update was made because this is contributor workflow documentation only, not a user-facing runtime change.UI Evidence
Not applicable; docs/workflow-only change.