morluto/rea

Fork 0

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

[PR #3287] [MERGED] docs(contributing): strengthen issue evidence guidance #5701

New issue

Closed

opened 2026-10-31 01:08:46 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:08:46 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3287
Author: @morluto
Created: 10/14/2026
Status: ✅ Merged
Merged: 10/14/2026
Merged by: @morluto

Base: main ← Head: codex/issue-evidence-guidance

📝 Commits (1)

173d618 docs(contributing): strengthen issue evidence guidance

📊 Changes

6 files changed (+72 additions, -19 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug_report.yml (+23 -13)
📝 .github/ISSUE_TEMPLATE/design_discussion.yml (+1 -1)
📝 .github/ISSUE_TEMPLATE/documentation.yml (+12 -3)
📝 .github/ISSUE_TEMPLATE/feature_request.yml (+4 -2)
📝 AGENTS.md (+11 -0)
📝 CONTRIBUTING.md (+21 -0)

📄 Description

Summary

Bug and documentation issue forms allow supporting evidence to be omitted, and several prompts leave room to present guesses as observations. Require an evidence response for those reports and make observations, source analysis, hypotheses, and unknowns explicit.

Problem and expected behavior

Maintainers should be able to trace an issue's claims to a command, result, artifact, screenshot, or source reference. Incomplete reports remain welcome: contributors can use NOT_ENOUGH_INFO with an explanation instead of inventing details.

Change and scope

Strengthen the existing bug and documentation prompts and require their evidence fields. Accept clearly labeled source-only reports and intermittent failures. Remove the bug evidence field's forced text rendering so reports can use ordinary Markdown.

Keep feature and design evidence optional, improve prompts for concrete examples and measured impact, and document the reporting rules in CONTRIBUTING.md and AGENTS.md. Existing field IDs and checkboxes are preserved; issue forms gain no human sign-off declaration.

Reference: OpenClaw bug form and documentation form.

Maintainer-requested contributor guidance update; no linked issue. Capability scope approval is not applicable to this documentation-only change.

Contract and boundary impact

Semantic owner and earliest changed stage: issue forms and contributor reporting guidance.
Contribution scope fit and linked maintainer decision: documentation only; new-capability approval is not applicable.
CLI and MCP/tool-catalog contract: no change.
Provider, bridge, target-format, or platform compatibility: no change.
Evidence, artifact, provenance, or reconstruction contract: no runtime change.
Target selection, authority, upstream behavior, and cleanup details: no target interaction.
Generated metadata, package, or installation impact: none.

Expected effects:

Documentation or usability only; no target interaction.

Evidence and regression coverage

Executed: all four issue forms parsed as YAML without errors or duplicate keys.
Executed: structural checks verified unique field IDs, required labels, unchanged field IDs and checkboxes, required bug/docs evidence responses, and optional feature/design verification details.
Executed: checked that the new AGENTS.md link points to the reporting section in CONTRIBUTING.md.
Source-derived: compared all changed prompts and reporting guidance for consistent treatment of missing evidence and source-only reports.
Tests added or updated: none; this changes issue-form configuration and prose.
Remaining proof gaps: live GitHub issue-form rendering has not been exercised. Required responses establish form completeness; maintainers assess whether the evidence supports a claim.

Validation performed

oxfmt --check on the six changed files — passed using the installed repository formatter and pinned Node.js 24.18.0.
git diff --check and git diff --cached --check — passed.
Inline Node.js validation using the installed yaml parser and assertions described above — passed for all four forms.
Full npm run docs:check, npm run check, and runtime/provider tests were not run.

Compatibility, safety, and release

Breaking changes or migration steps: none; existing issue field IDs are preserved.
Real Hopper/Ghidra, browser, or OS coverage: not applicable.
Package or release metadata impact: none.
Security, privacy, process, or containment review: existing contribution scope and credential/sensitive-data guidance remain in force.

Author readiness

Human owner: @morluto

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare the current revision ready for maintainer review.

Before merge

Material scope and authority questions are resolved.
Required checks pass for the current 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/3287 **Author:** [@morluto](https://github.com/morluto) **Created:** 10/14/2026 **Status:** ✅ Merged **Merged:** 10/14/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `codex/issue-evidence-guidance` --- ### 📝 Commits (1) - [`173d618`](https://github.com/morluto/rea/commit/173d6182e1bdf4c2d9918d3871928640cfb635f2) docs(contributing): strengthen issue evidence guidance ### 📊 Changes **6 files changed** (+72 additions, -19 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug_report.yml` (+23 -13) 📝 `.github/ISSUE_TEMPLATE/design_discussion.yml` (+1 -1) 📝 `.github/ISSUE_TEMPLATE/documentation.yml` (+12 -3) 📝 `.github/ISSUE_TEMPLATE/feature_request.yml` (+4 -2) 📝 `AGENTS.md` (+11 -0) 📝 `CONTRIBUTING.md` (+21 -0) </details> ### 📄 Description ## Summary Bug and documentation issue forms allow supporting evidence to be omitted, and several prompts leave room to present guesses as observations. Require an evidence response for those reports and make observations, source analysis, hypotheses, and unknowns explicit. ## Problem and expected behavior Maintainers should be able to trace an issue's claims to a command, result, artifact, screenshot, or source reference. Incomplete reports remain welcome: contributors can use `NOT_ENOUGH_INFO` with an explanation instead of inventing details. ## Change and scope Strengthen the existing bug and documentation prompts and require their evidence fields. Accept clearly labeled source-only reports and intermittent failures. Remove the bug evidence field's forced text rendering so reports can use ordinary Markdown. Keep feature and design evidence optional, improve prompts for concrete examples and measured impact, and document the reporting rules in CONTRIBUTING.md and AGENTS.md. Existing field IDs and checkboxes are preserved; issue forms gain no human sign-off declaration. Reference: [OpenClaw bug form](https://github.com/openclaw/openclaw/blob/main/.github/ISSUE_TEMPLATE/bug_report.yml) and [documentation form](https://github.com/openclaw/openclaw/blob/main/.github/ISSUE_TEMPLATE/docs_bug_report.yml). Maintainer-requested contributor guidance update; no linked issue. Capability scope approval is not applicable to this documentation-only change. ## Contract and boundary impact - Semantic owner and earliest changed stage: issue forms and contributor reporting guidance. - Contribution scope fit and linked maintainer decision: documentation only; new-capability approval is not applicable. - CLI and MCP/tool-catalog contract: no change. - Provider, bridge, target-format, or platform compatibility: no change. - Evidence, artifact, provenance, or reconstruction contract: no runtime change. - Target selection, authority, upstream behavior, and cleanup details: no target interaction. - Generated metadata, package, or installation impact: none. Expected effects: - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Executed: all four issue forms parsed as YAML without errors or duplicate keys. - Executed: structural checks verified unique field IDs, required labels, unchanged field IDs and checkboxes, required bug/docs evidence responses, and optional feature/design verification details. - Executed: checked that the new AGENTS.md link points to the reporting section in CONTRIBUTING.md. - Source-derived: compared all changed prompts and reporting guidance for consistent treatment of missing evidence and source-only reports. - Tests added or updated: none; this changes issue-form configuration and prose. - Remaining proof gaps: live GitHub issue-form rendering has not been exercised. Required responses establish form completeness; maintainers assess whether the evidence supports a claim. ## Validation performed - `oxfmt --check` on the six changed files — passed using the installed repository formatter and pinned Node.js 24.18.0. - `git diff --check` and `git diff --cached --check` — passed. - Inline Node.js validation using the installed `yaml` parser and assertions described above — passed for all four forms. - Full `npm run docs:check`, `npm run check`, and runtime/provider tests were not run. ## Compatibility, safety, and release - Breaking changes or migration steps: none; existing issue field IDs are preserved. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. - Package or release metadata impact: none. - Security, privacy, process, or containment review: existing contribution scope and credential/sensitive-data guidance remain in force. ## Author readiness Human owner: @morluto - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare the current revision ready for maintainer review. ## Before merge - [ ] Material scope and authority questions are resolved. - [ ] Required checks pass for the current revision. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:08:46 +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#5701

No description provided.

Rows
Columns