morluto/rea

Fork 0

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

[PR #1696] [CLOSED] docs(contributing): explain the first contribution workflow #4763

New issue

Closed

opened 2026-10-31 00:54:48 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 00:54:48 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1696
Author: @gautamggg53
Created: 10/11/2026
Status: ❌ Closed

Base: main ← Head: patch-1

📝 Commits (1)

755226b docs(contributing): explain the first contribution workflow

📊 Changes

1 file changed (+49 additions, -1 deletions)

View changed files

📝 CONTRIBUTING.md (+49 -1)

📄 Description

Summary

The contribution guide starts at dependency installation, leaving a first-time contributor without instructions for obtaining a checkout, creating a branch, or submitting a PR. Add the complete fork-to-PR workflow and show how to select the original repository as the changed-test baseline.

Problem and expected behavior

A contributor without write access needs a fork to push changes. Its origin/main may also be behind the original repository, so the default changed-test comparison can include unrelated upstream changes. The guide should explain origin and upstream, start feature branches at upstream/main, and show the supported --base upstream/main option.

No issue is linked: this is a focused correction to missing contributor instructions, with no new runtime or architectural proposal.

Change and scope

Only CONTRIBUTING.md changes:

Add fork, clone, upstream remote, fetch, and branch instructions.
Explain installing the pinned Node.js version before nvm use when using nvm.
Show changed source tests against upstream/main.
Add diff review, selective staging, conventional commit, push, and PR submission instructions.

Contract and boundary impact

Semantic owner and earliest changed stage: contributor documentation.
CLI and MCP/tool-catalog contract: none.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: none.
Process execution, authorization, cleanup, or containment impact: none.
Generated metadata, package, or installation impact: none; no generated files or dependency changes.

Evidence and regression coverage

Tests added or updated: none; documentation-only change.
Executed a disposable local Git workflow with a deliberately stale fork: clone, add upstream, fetch, branch from upstream/main, commit, and push succeeded. Verified the branch starts at current upstream and both main branches remain unchanged.
Checked the documented test baseline against the existing development-test parser and executed it.
User-visible CLI/MCP output: not applicable.
Remaining proof gaps: nvm installation itself and real-provider workflows were not exercised. The local fixture validates Git behavior; GitHub PR submission uses the normal web flow.

Validation performed

On macOS arm64 with pinned Node.js 24.18.0 and npm 11.16.0:

npm ci — passed.
npm run check — passed all six tasks and architecture guards; lint reported existing warnings and zero errors.
node_modules/.bin/oxfmt --check CONTRIBUTING.md — passed.
git diff --check — passed.
npm run test:changed -- --base upstream/main — passed; selected no source tests for this documentation-only change.
Local fork workflow described above — passed.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: no provider behavior changed; provider lanes and the full runtime suite were not run.
Package or release metadata impact: none.
Security, privacy, process, or containment review: diff contains only public contributor instructions and placeholders.

Review checklist

Concrete contributor onboarding problem and one focused outcome.
Conventional PR title; reason for no linked issue explained.
Documented commands validated as described; unexecuted coverage identified.
Owning documentation updated; no runtime contracts or generated files affected.
Final diff checked for unrelated changes, credentials, and unsupported claims.

Prepared with AI assistance.

_{🔄 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/1696 **Author:** [@gautamggg53](https://github.com/gautamggg53) **Created:** 10/11/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`755226b`](https://github.com/morluto/rea/commit/755226bbe0fdf971a8b9fec4b5d5cd495ab4f8cd) docs(contributing): explain the first contribution workflow ### 📊 Changes **1 file changed** (+49 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+49 -1) </details> ### 📄 Description ## Summary The contribution guide starts at dependency installation, leaving a first-time contributor without instructions for obtaining a checkout, creating a branch, or submitting a PR. Add the complete fork-to-PR workflow and show how to select the original repository as the changed-test baseline. ## Problem and expected behavior A contributor without write access needs a fork to push changes. Its `origin/main` may also be behind the original repository, so the default changed-test comparison can include unrelated upstream changes. The guide should explain `origin` and `upstream`, start feature branches at `upstream/main`, and show the supported `--base upstream/main` option. No issue is linked: this is a focused correction to missing contributor instructions, with no new runtime or architectural proposal. ## Change and scope Only `CONTRIBUTING.md` changes: - Add fork, clone, upstream remote, fetch, and branch instructions. - Explain installing the pinned Node.js version before `nvm use` when using nvm. - Show changed source tests against `upstream/main`. - Add diff review, selective staging, conventional commit, push, and PR submission instructions. ## Contract and boundary impact - Semantic owner and earliest changed stage: contributor documentation. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Process execution, authorization, cleanup, or containment impact: none. - Generated metadata, package, or installation impact: none; no generated files or dependency changes. ## Evidence and regression coverage - Tests added or updated: none; documentation-only change. - Executed a disposable local Git workflow with a deliberately stale fork: clone, add upstream, fetch, branch from upstream/main, commit, and push succeeded. Verified the branch starts at current upstream and both main branches remain unchanged. - Checked the documented test baseline against the existing development-test parser and executed it. - User-visible CLI/MCP output: not applicable. - Remaining proof gaps: nvm installation itself and real-provider workflows were not exercised. The local fixture validates Git behavior; GitHub PR submission uses the normal web flow. ## Validation performed On macOS arm64 with pinned Node.js 24.18.0 and npm 11.16.0: - `npm ci` — passed. - `npm run check` — passed all six tasks and architecture guards; lint reported existing warnings and zero errors. - `node_modules/.bin/oxfmt --check CONTRIBUTING.md` — passed. - `git diff --check` — passed. - `npm run test:changed -- --base upstream/main` — passed; selected no source tests for this documentation-only change. - Local fork workflow described above — passed. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: no provider behavior changed; provider lanes and the full runtime suite were not run. - Package or release metadata impact: none. - Security, privacy, process, or containment review: diff contains only public contributor instructions and placeholders. ## Review checklist - [x] Concrete contributor onboarding problem and one focused outcome. - [x] Conventional PR title; reason for no linked issue explained. - [x] Documented commands validated as described; unexecuted coverage identified. - [x] Owning documentation updated; no runtime contracts or generated files affected. - [x] Final diff checked for unrelated changes, credentials, and unsupported claims. Prepared with AI assistance. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 00:54:48 +00:00

closed this issue
added the
pull-request
label

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#4763

No description provided.

Rows
Columns