Skip to content

docs: clarify contributor responsibility for agent-assisted changes - #7895

Merged
Kitenite merged 2 commits into
mainfrom
copy-mlx-agents
Sep 27, 2026
Merged

Kitenite merged 2 commits into
mainfrom
copy-mlx-agents

Conversation

@Kitenite

@Kitenite Kitenite commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

What & why

Add contributor responsibility guidance inspired by MLX's AGENTS.md. Contributors must understand, review, and verify submitted changes, including agent-generated code.

Explicitly allow authorized agent assistance with commit messages, PR descriptions, commits, pushes, PR creation, and review feedback. Require explicit user authorization before posting reviewer replies and accurate reporting of validation. No blanket prohibition on agent-created PRs or contributor-ban language.

Also copy MLX's code standards while preserving the existing Superset instructions.

How I tested it

  • git diff --check passed.
  • bun run lint:fix and bun run lint passed; no fixes were needed.
  • bun run typecheck passed (42 tasks).
  • bun run test stopped on a five-second timeout in the existing i18n display-only test. Running bun test packages/i18n/test/display-only.test.ts separately passed all 10 tests.

Checklist

  • PR title follows conventional commits (type(scope): subject)
  • bun run lint and bun run typecheck pass (CI fails on lint warnings too)
  • "Allow edits from maintainers" is checked on fork PRs (not applicable: same-repository branch)

Summary by CodeRabbit

  • Documentation
    • Updated contributor guidance with expectations for reviewing and validating changes, clarifying requests, explaining work, and responding to reviews.
    • Added guidance on authorized agent actions and accurately reporting completed checks.
    • Added standards and examples for concise comments and clear technical writing. These updates provide clearer guidance for preparing and reviewing contributions.

@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 8e532d51-738b-4dc3-9ec0-734b4b80943d

📥 Commits

Reviewing files that changed from the base of the PR and between 3fe2c36 and 528a795.

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

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.


📝 Walkthrough

Walkthrough

AGENTS.md adds contributor responsibilities for reviewing and verifying changes, handling underspecified requests, and describing agent actions and validation. It also adds code standards for concise comments and Simplified Technical English, with C++ comment examples.

Changes

Contributor guidance

Layer / File(s) Summary
Contributor responsibilities and code standards
AGENTS.md
Adds guidance for review, verification, unclear requests, authorized agent actions, reviewer replies, and accurate claims about checks. Adds comment-writing standards and C++ examples.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: saddlepaddle

Merge Risk: ⚪ Minimal · up to 528a7

The guidance preserves useful explanations of non-obvious traps while discouraging overly detailed comments. No material merge-readiness concern is established.

Architecture Summary

Architecture risk: 🔵 Low · up to 528a7

The change affects 1 system.

Changed systems: AGENTS.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — AGENTS.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in AGENTS.md: Adds contributor responsibilities and code standards, including limits on agent actions and claims, plus examples contrasting uncommented self-describing code with excessive commentary.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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…
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.
Title check ✅ Passed The title uses the docs commit type and clearly identifies the main change: contributor guidance for agent-assisted changes.
Description check ✅ Passed The description includes the required What & why, How I tested it, and Checklist sections. It explains the documentation changes and reports validation results, including the test timeout and separate…
✨ Finishing Touches 💡 1
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR

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.

@Kitenite Kitenite changed the title docs: adopt MLX contributor rules for agent-assisted contributions docs: clarify contributor responsibility for agent-assisted changes Sep 27, 2026
@github-actions

github-actions Bot commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

  • ✅ Neon database branch

Thank you for your contribution! 🎉

@Kitenite
Kitenite merged commit 46eb661 into main Sep 27, 2026
19 of 20 checks passed
Kitenite added a commit that referenced this pull request Oct 1, 2026
* docs: weekly update for PRs merged 2026-09-23 to 2026-09-30

Source of truth: live Notion SOP "Weekly Docs Update (automation SOP)".
Window: merged:>=2026-09-23 (139 PRs). PRs through the morning of 09-23
were covered by #7771.

Changes
- Pages: no auto-open on publish (#7790); page links and URL links split
  into their own settings (#7916, #7962, #7946); Listening agents menu with
  per-row stop and Add listening agent (#7724, #7820, #7919); globe on the
  Share button (#7766); Report on public pages (#7886); agents offer a page
  (#7759). Files: pages.mdx, cli/cli-reference.mdx.
- Settings moves: Links replaced by Browser and Files & Editor (#7916,
  #7962). Files: editor.mdx, terminal-integration.mdx, customization.mdx.
- Editor: inline rename and drag to move (#7692), Auto Save (#7693, #7916),
  open and save files outside the workspace (#7897, #7982), Copy as Markdown
  (#7591), per-pane error screen (#7983). File: editor.mdx.
- Terminal copy follows Ghostty's whitespace rules (#7868).
  File: terminal-integration.mdx.
- Agents: UFO (#7898); GPT-6 Astra, Sonnet 5.5, retiring GPT-5.5, retired
  GPT-5.4/5.3 Codex (#7783, #7894, #7935). Files: agent-integration.mdx,
  cli/cli-reference.mdx.
- Host: superset start --daemon --auto-update and update-lock permission
  errors (#7735, #7952). Files: cli/host-server.mdx, cli/cli-reference.mdx.
- Removed the mcp CLI section and the Connected Service Plugins section:
  #7776 made plugins/mcp internal, the Plugins page is staff-flagged, and
  apps/docs/AGENTS.md keeps internal commands out. Files: skills.mdx,
  cli/cli-reference.mdx.
- Slack page unfurls and details panel (#7817, #7821, #7914, #7957).
  File: use-with-slack.mdx.
- Workspaces: instant creation with background naming (#7518); recoverable
  project deletion (#7896). File: workspaces.mdx.
- Shortcuts: prev/next workspace includes Pinned and wraps (#7851); ⌘B
  collapses the sidebar to a rail (#7964). File: keyboard-shortcuts.mdx.
- Ship controls and open-in button moved to the right sidebar strip (#7958).
  Files: diff-viewer.mdx, use-with-ide.mdx.

Deliberately skipped
- Cloud workspaces/environments/sandboxes (flag-gated, AGENTS.md rule):
  #7784 #7795 #7824 #7840 #7844 #7845 #7847 #7849 #7850 #7858 #7861 #7863
  #7874 #7911 #7913 #7918 #7922 #7931 #7932 #7937 #7956 #7961 #7969 #7981
  #7637 #7794 #7789 #7838 (its CLI docs already shipped in the PR).
- Staff-only plugins: #7912 Sentry plugin, #7716, #7727, #7955.
- Already documented in their own PRs: #7917, #7921.
- Removed feature never documented: #7796 Google Calendar triggers.
- Agents chip remove/revert/default-off, never documented: #7870 #7871 #7872.
- Billing/backend policy with no docs surface: #7947, #7812, #7786, #7792,
  #7798, #7761, #7948, #7949, #7951, #7827.
- Reverted security trio: #7828 #7829 #7830 (reverted by #7834).
- Fixes restoring expected behavior: #7683 #7696 #7707 #7743 #7751 #7756
  #7764 #7765 #7781 #7788 #7791 #7823 #7825 #7833 #7837 #7852 #7857 #7860
  #7864 #7865 #7869 #7873 #7897-covered #7903 #7938 #7980 #7943 #7964-chrome.
- Mobile (no docs page): #7746 #7747 #7748 #7749 #7750 #7782 #7793 #7810
  #7814 #7816 #7889 #7968.
- Marketing, internal docs, CI, version bumps: #7651 #7744 #7752 #7771 #7774
  #7776-infra #7777 #7785 #7811 #7818 #7822 #7826 #7834 #7884 #7885 #7895
  #7909 #7933 #7934 #7942 #7944 #7965 #7966.

Validation: bun run --cwd apps/docs typecheck, bun run lint:fix,
bun run lint (exit 0), Vale on 13 changed files (0 errors, 0 warnings),
git diff --check.

* chore: log weekly docs update follow-ups

* docs: tighten review findings in the weekly update

Only the page creator can stop or add listening agents. On focus change also
saves on window blur, and Auto Save pauses on conflicts. Taken-down pages do
not unfurl. Model picker coverage matches agent-models.ts.

This branch was previously deployed

1 inactive deployment
preview — 528a7953 Deployed Sep 27, 2026 by Kitenite via Deploy Marketing #10473
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