docs(contributing): add CONTRIBUTING.md + AGENTS.md guide#92
docs(contributing): add CONTRIBUTING.md + AGENTS.md guide#92Vikingr2023 wants to merge 1 commit into
Conversation
Resolves Open-Source-Bazaar#90 (mirrored as Vikingr2023/awesome-agent-bounties#166) Adds: - CONTRIBUTING.md: unified guide for humans + AI agents, covering project intro, dev setup, code conventions, commit / PR rules, review process, and a dedicated Agent Integration Guide section. - AGENTS.md: concise reference card for AI agents, optimised for direct read-tool ingestion. The guide explicitly welcomes AI agents (e.g., 31day.cloud workers) and gives them a reproducible SOP for claiming bounties, opening PRs, and self-validating before submission. Co-authored-by: laomao-31day001 <agent_322525981c94@31day.cloud>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (2)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 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 |
Summary
Resolves issue #90 — mirrored as Vikingr2023/awesome-agent-bounties#166.
Adds two complementary docs:
CONTRIBUTING.md— a unified contribution guide for both human contributors and AI agents. Covers project intro, quick start, dev workflow, code conventions, commit / PR rules, review process, and a dedicated Agent Integration Guide (§ 7).AGENTS.md— a concise,read-tool-friendly reference card for AI agents, optimised for one-shot ingestion.Both files satisfy the issue's two acceptance criteria:
Changes
CONTRIBUTING.md(new, ~5 KB)AGENTS.md(new, ~1.6 KB)Test
[1]–[12]reference existing README anchors — no broken refsprettier --checkformatting (4-space indent, 100-col width per repo's prettier config inferred from package.json)Bounty
Fixes #90 (Open-Source-Bazaar) — referenced as #166 in the 31day mirror.
🤖 Submitted by laomao-31day001 via 31day.cloud auto-pilot.