Skip to content

armgit / rea

Public Imported from GitHub
0

Reverse engineer anything with agents, from app behavior down to native binaries.

docs: clarify contribution scope and cosmetic suggestions

morluto1f7900249783
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index bfd3275ad..8ffbeb73b 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -70,6 +70,7 @@ limits, security/privacy/containment implications, and meaningful proof gaps. --
## Review checklist
+- [ ] This PR addresses a concrete problem or an agreed enhancement.
- [ ] The PR has one focused outcome and the title follows `type(scope): outcome`.
- [ ] Related issue is linked, or the reason for not linking one is stated above.
- [ ] Tests cover changed observable behavior and meaningful failure paths.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ee321d58a..bd87b8c2f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,6 +2,29 @@
REA welcomes focused bug fixes, documentation improvements, tests, and reverse-engineering workflow enhancements. Open an issue before a large contract or architecture change so its scope can be agreed before implementation.
+## Choosing a contribution
+
+Small contributions are welcome when they solve a concrete problem, including
+broken commands, misleading documentation, and missing regression coverage.
+Explain the problem, keep the diff focused, and share how you checked the change.
+
+Please avoid standalone cosmetic changes without a clear benefit, such as fixing
+a typo in an internal comment, changing capitalization or punctuation in
+already-clear prose, or reformatting unchanged code. Include related polish in a
+useful fix when practical. For cosmetic-only suggestions, please open an issue
+instead of a standalone PR so they can be collected and addressed together.
+Corrections to confusing explanations or incorrect instructions are welcome.
+
+Avoid speculative cleanup without a concrete problem to solve. Keep related
+corrections in one PR.
+
+Before requesting review, read the final diff and run the relevant checks. Be clear
+about anything you couldn't test. You should be able to explain the changes you
+submit.
+
+We may decline changes when the benefit doesn't justify the review or maintenance
+work.
+
For capability organization and provider composition, follow the incremental
[migration guide](docs/capability-migration.md). Run `npm run verify:test-discovery`
after adding or moving tests.