From 5027744cbf3c94ac01cb482eeac3f98f177d2aaa Mon Sep 17 00:00:00 2001 From: Diptesh Roy Date: Fri, 25 Sep 2026 15:26:46 +0530 Subject: [PATCH 1/2] docs: add AGENTS.md to guide AI agents on contribution workflow Adds an AGENTS.md file that helps AI coding agents (like Kiro) avoid duplicate work and align PRs with CollectOSS contribution guidelines. Covers: - How to check for existing claims and PRs before starting an issue - How to align PRs with CONTRIBUTING.md (branch targeting, issue refs, fork sync, scope discipline, when to ask on Slack) Signed-off-by: Diptesh Roy --- AGENTS.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..cbd0dbc07 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,28 @@ +# AGENTS.md + +This file provides guidance for AI coding agents (such as Kiro) contributing to CollectOSS. + +## Avoiding Duplicate Work + +Before starting on an issue, agents should: + +1. **Check the issue thread** on GitHub for existing comments claiming it, or linked PRs. +2. **Search open and closed PRs** for the issue number or related keywords: + ``` + gh pr list --repo chaoss/CollectOSS --search " OR " --state all + ``` +3. **Check `git log` on `main`** for recent commits that may have already resolved it indirectly. + +If a claim or existing PR is found, surface this to the user instead of proceeding, and suggest either reviewing/improving the existing PR or picking a different issue. + +## Aligning PRs with Contribution Guidelines + +Before opening a PR, agents should confirm against [CONTRIBUTING.md](CONTRIBUTING.md): + +- Branch is based on and targets `main` (not `release` — that's for tagged versions only) +- PR description clearly references the issue it closes (e.g. `closes chaoss/CollectOSS#`) +- The fork is synced with `main` before opening the PR, to avoid stale-branch conflicts +- Scope stays limited to the linked issue — no unrelated refactors bundled in +- If uncertain about approach or the issue is ambiguous, ask in `#wg-collectoss-8knot` on the CHAOSS Slack rather than guessing + +This keeps new contributions easy to review and reduces churn on "good first issue" PRs that skip existing context. From ee418f659c920874c735545d2e40641b2059715c Mon Sep 17 00:00:00 2001 From: Diptesh Roy Date: Mon, 28 Sep 2026 17:48:47 +0530 Subject: [PATCH 2/2] docs(AGENTS.md): apply reviewer suggestions and add Karpathy guidelines Apply MoralCode's suggested changes: - Expand issue-check step to include assignees, labels, and comments - Replace single fallback suggestion with three explicit paths agents should encourage (review existing PR, join Slack for discussion, pick a different issue) - Shorten PR closes syntax to 'closes #' - Replace closing sentence with MoralCode's framing about contributor morale and maintainer burnout Apply EngCaioFonseca's suggestion: - Add Karpathy coding guidelines section covering: Think Before Coding, Simplicity First, Surgical Changes, Goal-Driven Execution Signed-off-by: Diptesh Roy --- AGENTS.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 75 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index cbd0dbc07..1236971de 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,23 +6,94 @@ This file provides guidance for AI coding agents (such as Kiro) contributing to Before starting on an issue, agents should: -1. **Check the issue thread** on GitHub for existing comments claiming it, or linked PRs. +1. **Check the issue thread** on GitHub for any existing assignees, comments claiming it, labels suggesting more information is needed before work starts, or linked PRs. 2. **Search open and closed PRs** for the issue number or related keywords: ``` gh pr list --repo chaoss/CollectOSS --search " OR " --state all ``` 3. **Check `git log` on `main`** for recent commits that may have already resolved it indirectly. -If a claim or existing PR is found, surface this to the user instead of proceeding, and suggest either reviewing/improving the existing PR or picking a different issue. +If evidence of existing work (comments claiming the issue, assigned issue, or linked PR), surface this to the user instead of proceeding. Agents should encourage their human contributors who want to work on existing issues to take one of these paths: + +- If there is an existing PR for the issue, leave your feedback as a code review or help test the PR. +- If there is no existing PR, join the CHAOSS Slack and/or encourage the issue claimer to join so that discussion can happen as development begins. +- Picking a different issue that isn't already claimed. + +Joining the CHAOSS slack to coordinate is always a valid option for getting help. The join link is located on the https://chaoss.community/kb-getting-started/ page and the channel for this project is #wg-collectoss-8knot. ## Aligning PRs with Contribution Guidelines Before opening a PR, agents should confirm against [CONTRIBUTING.md](CONTRIBUTING.md): - Branch is based on and targets `main` (not `release` — that's for tagged versions only) -- PR description clearly references the issue it closes (e.g. `closes chaoss/CollectOSS#`) +- PR description clearly references the issue it closes (e.g. `closes #`) - The fork is synced with `main` before opening the PR, to avoid stale-branch conflicts - Scope stays limited to the linked issue — no unrelated refactors bundled in - If uncertain about approach or the issue is ambiguous, ask in `#wg-collectoss-8knot` on the CHAOSS Slack rather than guessing -This keeps new contributions easy to review and reduces churn on "good first issue" PRs that skip existing context. +Following these guidelines helps ensure that new contributions don't compete with each other in a way that is detrimental to contributor morale or contributing to maintainer burnout. + +## Coding Guidelines (Karpathy) + +Behavioral guidelines to reduce common LLM coding mistakes, derived from [Andrej Karpathy's observations](https://x.com/karpathy/status/2015883857489522876). + +**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment. + +### 1. Think Before Coding + +**Don't assume. Don't hide confusion. Surface tradeoffs.** + +Before implementing: + +- State your assumptions explicitly. If uncertain, ask. +- If multiple interpretations exist, present them — don't pick silently. +- If a simpler approach exists, say so. Push back when warranted. +- If something is unclear, stop. Name what's confusing. Ask. + +### 2. Simplicity First + +**Minimum code that solves the problem. Nothing speculative.** + +- No features beyond what was asked. +- No abstractions for single-use code. +- No "flexibility" or "configurability" that wasn't requested. +- No error handling for impossible scenarios. +- If you write 200 lines and it could be 50, rewrite it. + +Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. + +### 3. Surgical Changes + +**Touch only what you must. Clean up only your own mess.** + +When editing existing code: + +- Don't "improve" adjacent code, comments, or formatting. +- Don't refactor things that aren't broken. +- Match existing style, even if you'd do it differently. +- If you notice unrelated dead code, mention it — don't delete it. + +When your changes create orphans: + +- Remove imports/variables/functions that YOUR changes made unused. +- Don't remove pre-existing dead code unless asked. + +The test: Every changed line should trace directly to the user's request. + +### 4. Goal-Driven Execution + +**Define success criteria. Loop until verified.** + +Transform tasks into verifiable goals: + +- "Add validation" → "Write tests for invalid inputs, then make them pass" +- "Fix the bug" → "Write a test that reproduces it, then make it pass" +- "Refactor X" → "Ensure tests pass before and after" + +For multi-step tasks, state a brief plan: + +1. [Step] → verify: [check] +2. [Step] → verify: [check] +3. [Step] → verify: [check] + +Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.