morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #3074] docs: clarify automated agent development setup #5593

New issue

Open

opened 2026-10-31 01:07:50 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:07:50 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3074
Author: @lwh94119-sketch
Created: 10/14/2026
Status: 🔄 Open

Base: main ← Head: codex/document-agent-development-setup

📝 Commits (1)

52aed89 docs: clarify automated agent development setup

📊 Changes

2 files changed (+43 additions, -0 deletions)

View changed files

📝 AGENTS.md (+12 -0)
📝 CONTRIBUTING.md (+31 -0)

📄 Description

Summary

Clarify source-checkout preparation for ChatGPT/Codex using REA's existing pinned toolchain and npm scripts.

Problem and expected behavior

The README's npx rea-agents setup registers an analysis client; it does not bootstrap a contributor checkout. Automated development sessions should install locked dependencies during network-enabled setup and report unavailable checks explicitly.

Change and scope

Add a short checkout entry point to AGENTS.md, including the website's existing subtree guidance.
Document the existing HUSKY=0 prepare behavior, PowerShell environment restoration, and offline dependency requirements in CONTRIBUTING.md.
Preserve existing repository rules, managed Turborepo instructions, toolchain pins and npm scripts.

No issue is linked: this is a focused repository onboarding request.

Contract and boundary impact

Semantic owner: contributor setup documentation.
Contribution scope: routine documentation within existing boundaries; advance maintainer scope decision not applicable.
CLI/MCP, providers, Evidence, target authority, cleanup and generated metadata: unchanged.
Documentation or usability only; no target interaction.

Evidence and regression coverage

Checked instructions against .nvmrc, package.json, .npmrc, scripts/prepare.mjs, hooks and CI setup. Referenced commands, file targets and headings were verified against the source checkout. Existing AGENTS.md and CONTRIBUTING.md are unchanged on the newer branch base, so the prepared additions apply without replacing upstream edits. No tests added for documentation-only guidance.

Validation performed

git diff --check: passed on the prepared local change.
Node.js source-reference check: passed for named npm scripts, file targets, heading anchors and Husky prepare handling.
GitHub commit comparison: exactly two files, 43 additions, no deletions; one commit above current fork base.
npm run check / npm run format:check: not run; npm is unavailable locally and available Node.js differs from the development pin. CI validation remains pending.
Real-provider verification: not applicable.

Compatibility, safety, and release

No breaking change, migration, runtime behavior, dependency, package or release metadata change. No analysis-client configuration or provider was installed by this change.

Before merge

Focused outcome and Conventional Commit title.
Material scope and authority resolved for documentation-only guidance.
Owning documentation updated.
Final diff checked for unrelated changes, secrets and unsupported claims.
Required checks pass for the final PR revision.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/3074 **Author:** [@lwh94119-sketch](https://github.com/lwh94119-sketch) **Created:** 10/14/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `codex/document-agent-development-setup` --- ### 📝 Commits (1) - [`52aed89`](https://github.com/morluto/rea/commit/52aed894c2cb2efddd45d80fd9822f8bc81158b4) docs: clarify automated agent development setup ### 📊 Changes **2 files changed** (+43 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `AGENTS.md` (+12 -0) 📝 `CONTRIBUTING.md` (+31 -0) </details> ### 📄 Description ## Summary Clarify source-checkout preparation for ChatGPT/Codex using REA's existing pinned toolchain and npm scripts. ## Problem and expected behavior The README's `npx rea-agents setup` registers an analysis client; it does not bootstrap a contributor checkout. Automated development sessions should install locked dependencies during network-enabled setup and report unavailable checks explicitly. ## Change and scope - Add a short checkout entry point to `AGENTS.md`, including the website's existing subtree guidance. - Document the existing `HUSKY=0` prepare behavior, PowerShell environment restoration, and offline dependency requirements in `CONTRIBUTING.md`. - Preserve existing repository rules, managed Turborepo instructions, toolchain pins and npm scripts. No issue is linked: this is a focused repository onboarding request. ## Contract and boundary impact - Semantic owner: contributor setup documentation. - Contribution scope: routine documentation within existing boundaries; advance maintainer scope decision not applicable. - CLI/MCP, providers, Evidence, target authority, cleanup and generated metadata: unchanged. - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage Checked instructions against `.nvmrc`, `package.json`, `.npmrc`, `scripts/prepare.mjs`, hooks and CI setup. Referenced commands, file targets and headings were verified against the source checkout. Existing AGENTS.md and CONTRIBUTING.md are unchanged on the newer branch base, so the prepared additions apply without replacing upstream edits. No tests added for documentation-only guidance. ## Validation performed - `git diff --check`: passed on the prepared local change. - Node.js source-reference check: passed for named npm scripts, file targets, heading anchors and Husky prepare handling. - GitHub commit comparison: exactly two files, 43 additions, no deletions; one commit above current fork base. - `npm run check` / `npm run format:check`: not run; npm is unavailable locally and available Node.js differs from the development pin. CI validation remains pending. - Real-provider verification: not applicable. ## Compatibility, safety, and release No breaking change, migration, runtime behavior, dependency, package or release metadata change. No analysis-client configuration or provider was installed by this change. ## Before merge - [x] Focused outcome and Conventional Commit title. - [x] Material scope and authority resolved for documentation-only guidance. - [x] Owning documentation updated. - [x] Final diff checked for unrelated changes, secrets and unsupported claims. - [ ] Required checks pass for the final PR revision. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-31 01:07:50 +00:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#5593

No description provided.

Rows
Columns