Skip to content

docs: add CONTRIBUTING.md for AI accessibility - #347

Merged
gosunuts merged 5 commits into
mainfrom
docs/contributing-ai-accessibility
Aug 28, 2026
Merged

docs: add CONTRIBUTING.md for AI accessibility#347
gosunuts merged 5 commits into
mainfrom
docs/contributing-ai-accessibility

Conversation

@gosunuts

Copy link
Copy Markdown
Member

CONTRIBUTING.md is the contribution-policy entry. AGENTS.md stays the core implementation guide.

Agents may file CLI, log, docs, and skill friction without prior assignment. Repeated agent instructions are treated as accessibility bugs: fix the Portal surface and delete the instruction. Protocol, trust, identity, and transport stay under AGENTS.md. The merge bar is #346. No plugin workflow engine (#331).

README Contributing sections now point at this file.

Closes #327

Post-Deploy Monitoring & Validation

No runtime impact. Confirm the README Contributing link opens CONTRIBUTING.md.

AGENTS.md stays the core implementation guide. Contribution
policy lives here: agents may file access-surface issues
without assignment; repeated skill instructions are bugs.
Merge bar is #346. Core protocol stays under AGENTS.md.

Closes #327
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: e93a3c49-08d4-42c1-9a50-9d458e4be6cf

📥 Commits

Reviewing files that changed from the base of the PR and between 45bba3c and 7a9e3cb.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: Analyze (go)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md

[style] ~25-~25: ‘on the basis of’ might be wordy. Consider a shorter alternative.
Context: ... the core should not be accepted solely on the basis of automated reasoning or agent usability....

(EN_WORDINESS_PREMIUM_ON_THE_BASIS_OF)

🔇 Additional comments (1)
CONTRIBUTING.md (1)

3-25: LGTM!


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Expanded the contribution guide with separate guidance for human and AI contributors, including supported work areas and required human review for security- and architecture-sensitive changes.
    • Clarified that issues, reviews, and improvement proposals may be submitted without prior assignment.
    • Updated the English and Chinese README files to link directly to the contribution guide instead of duplicating contribution steps.

Walkthrough

The PR updates CONTRIBUTING.md with human and AI contribution guidance. The English and Chinese READMEs now link to this document instead of listing contribution steps. No runtime or public API changes are included.

Changes

Contribution Policy

Layer / File(s) Summary
Contribution policy and README links
CONTRIBUTING.md, README.md, README.zh-CN.md
CONTRIBUTING.md defines AI contribution areas and human review requirements for core changes. Both README files link to the policy document.

Merge Risk: ⚪ Minimal · up to 7a9e3

This change updates contribution guidance and README links without runtime or production behavior impact; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title uses the conventional docs: prefix and accurately describes the addition of CONTRIBUTING.md for AI accessibility.
Description check ✅ Passed The description clearly explains the contribution-policy changes and the README links. It is directly related to the changeset.
Linked Issues check ✅ Passed The changes satisfy issue #327 by adding the contribution-policy entry point, defining AI accessibility guidance, preserving stronger core implementation requirements, and linking the guide from the R…
Out of Scope Changes check ✅ Passed The changes are limited to contribution guidance and README navigation. These changes are within the scope of issue #327.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The changes satisfy issue #327 by adding the contribution-policy entry point, defining AI accessibility guidance, preserving stronger core implementation requirements, and linking the guide from the READMEs.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/contributing-ai-accessibility

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.

@gosunuts
gosunuts merged commit 457c42f into main Aug 28, 2026
5 of 6 checks passed
@gosunuts
gosunuts deleted the docs/contributing-ai-accessibility branch August 28, 2026 07:52
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.

Add CONTRIBUTING.md with an AI accessibility contribution policy

1 participant