Skip to content

docs(contributing): add CONTRIBUTING.md + AGENTS.md guide#92

Open
Vikingr2023 wants to merge 1 commit into
Open-Source-Bazaar:mainfrom
Vikingr2023:docs/contributing-guide
Open

docs(contributing): add CONTRIBUTING.md + AGENTS.md guide#92
Vikingr2023 wants to merge 1 commit into
Open-Source-Bazaar:mainfrom
Vikingr2023:docs/contributing-guide

Conversation

@Vikingr2023

@Vikingr2023 Vikingr2023 commented Jul 13, 2026

Copy link
Copy Markdown

PR-92 PR-92 PR-92 Powered by Pull Request Badge

Summary

Resolves issue #90 — mirrored as Vikingr2023/awesome-agent-bounties#166.

Adds two complementary docs:

  1. 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).
  2. 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:

  • "符合当前社区代码规范及习惯" → CONTRIBUTING.md derives its style from the upstream idea2app/Lark-Next-Bootstrap-ts conventions referenced in the existing README.
  • "形成可供 Agent 使用的 md 文档" → AGENTS.md is intentionally short and structured for AI agent context loading, with explicit § 禁止 / 任务接单 SOP / 命令速查 sections.

Changes

File Purpose
CONTRIBUTING.md (new, ~5 KB) Unified human + agent contribution guide (8 sections)
AGENTS.md (new, ~1.6 KB) Agent quick-reference card

Test

  • Markdown renders correctly on GitHub preview (no broken anchors, links to upstream confirmed)
  • Linked badges [1]–[12] reference existing README anchors — no broken refs
  • Both files pass prettier --check formatting (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.

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>
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • AGENTS.md is excluded by !**/*.md and included by none
  • CONTRIBUTING.md is excluded by !**/*.md and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3b8e1737-2899-417d-9e75-7846ce092598

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

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.

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