Skip to content
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
mainfrom
docs/contributor-pr-workflow
Draft

Add contributor workflow docs#56
Xelvanis wants to merge 4 commits into
mainfrom
docs/contributor-pr-workflow

Conversation

@Xelvanis
Copy link
Copy Markdown
Collaborator

@Xelvanis Xelvanis commented May 22, 2026

Linked Issue

No linked issue; this PR adapts contributor workflow docs and PR preparation guidance for ME-Refactor.

Why This Change

  • ME-Refactor has repo-local agent/developer guidance, but no contributor guide or PR template aligned with the current Tauri architecture.
  • This gives contributors and reviewers shared guidance for ownership, impact area, AI-assisted contributions, and validation without carrying over legacy repo assumptions.

Owner And Impact

  • Owner: repo docs/contributor workflow
  • Behavior changed: no runtime behavior; adds contributor guidance and PR preparation structure
  • Expected impact area: contributor onboarding, PR descriptions, and docs validation
  • Dependent callers reviewed: README, AGENTS workflow guidance, and docs/developer architecture/module/impact guidance
  • Affected modes/capabilities: none
  • Rust/TypeScript boundary touched: no

What Changed

  • Added CONTRIBUTING.md for ME-Refactor setup, branch flow, architecture ownership, AI-assisted contribution rules, validation, PR expectations, and release/version notes.
  • Added .github/pull_request_template.md with owner/impact fields, free-text architecture notes, validation prompts, and explicit agent checkbox guidance.
  • Linked the contributor guide from README.md.
  • Extended pnpm check:docs to require the contributor guide and PR template, catch stale legacy terms, and enforce the current PR template headings/check guidance.
  • Added pnpm check:architecture to 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 Review checkbox 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:architecture passes locally, if imports, file layout, feature boundaries, engine layers, shared APIs, or Rust command structure changed
  • pnpm typecheck passes locally
  • pnpm check:rust passes locally
  • pnpm check:docs passes locally
  • pnpm build passes locally, if imports, bundling, or runtime UI paths changed
  • pnpm check passes locally, if this PR is ready for broad evaluation
  • Ran the app and clicked through the changed workflow manually
  • Checked relevant edge cases, such as light/dark mode, mobile viewport, empty states, error paths, provider/storage failures, or persisted-data migration paths
  • Read and followed CONTRIBUTING.md, AGENTS.md, and the relevant docs/developer/ pages

Manual Verification Notes

  • pnpm check:docs passed after the contributor workflow and PR template revisions.
  • git diff --check was clean aside from normal Windows line-ending notices.
  • Scanned the contributor guide and PR template for legacy repo terms such as old branch, workspace, backend, container, and missing-changelog assumptions.

Docs And Release Impact

  • No docs/release changes needed
  • Updated developer or user docs as needed
  • Updated release notes/changelog if this is user-facing and release-noteworthy
  • Version/release files updated only if this PR intentionally includes a version bump

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.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 22, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f70ab657-4c1b-4881-b62a-f6b71e574b30

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/contributor-pr-workflow

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants