Skip to content

RFC 002: PR Contribution Guidelines#302

Open
chaodu-agent wants to merge 2 commits intoopenabdev:mainfrom
chaodu-agent:rfc/pr-guidelines
Open

RFC 002: PR Contribution Guidelines#302
chaodu-agent wants to merge 2 commits intoopenabdev:mainfrom
chaodu-agent:rfc/pr-guidelines

Conversation

@chaodu-agent
Copy link
Copy Markdown
Collaborator

@chaodu-agent chaodu-agent commented Apr 13, 2026

What problem does this solve?

OpenAB is growing and accepting external contributions. Without a clear PR standard, we see PRs that jump straight to implementation without researching how existing projects solve the same problem, making reviews harder and risking reinventing the wheel.

What's in this PR

File Purpose
docs/steering/rfc-pr-guidelines.md Full RFC — problem, proposal, rationale, implementation plan
.github/pull_request_template.md Auto-populated PR form with all required sections
CONTRIBUTING.md Contributor guide explaining the guidelines

Key decisions

  • OpenClaw + Hermes Agent research is mandatory for every PR — these two cover the broadest design space relevant to OpenAB
  • Contributors must document: what problem they solve, prior art, proposed solution, why this approach, alternatives considered, and test plan
  • Front-loads research cost onto the contributor (who understands the problem best) rather than distributing it across reviewers

Open questions (in the RFC)

  1. Should we enforce the prior art section via CI?
  2. Should we maintain a living doc of "how OpenClaw/Hermes do X"?
  3. Are there other mandatory reference projects beyond these two?

@chaodu-agent chaodu-agent requested a review from thepagent as a code owner April 13, 2026 19:14
@chaodu-agent chaodu-agent force-pushed the rfc/pr-guidelines branch 2 times, most recently from 7d5a23e to 7ffcd81 Compare April 13, 2026 19:23
@chaodu-agent chaodu-agent changed the title rfc: PR contribution guidelines with mandatory prior art research RFC 002: PR Contribution Guidelines Apr 13, 2026
@chaodu-agent chaodu-agent force-pushed the rfc/pr-guidelines branch 7 times, most recently from 951c3d3 to e90afe2 Compare April 13, 2026 19:37
Add RFC, PR template, and CONTRIBUTING.md requiring contributors to
research OpenClaw and Hermes Agent before proposing solutions.

- docs/rfcs/002-pr-guidelines.md — full RFC (follows RFC 001 format)
- .github/pull_request_template.md — auto-populated PR form
- CONTRIBUTING.md — contributor guide linking to RFC
@github-actions
Copy link
Copy Markdown

⚠️ This PR is missing a Discord Discussion URL in the body.

All PRs must reference a prior Discord discussion to ensure community alignment before implementation.

Please edit the PR description to include a link like:

Discord Discussion URL: https://discord.com/channels/...

This PR will be automatically closed in 3 days if the link is not added.

@github-actions github-actions bot added the closing-soon PR missing Discord Discussion URL — will auto-close in 3 days label Apr 14, 2026
@thepagent thepagent added the p3 Low — nice to have label Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

closing-soon PR missing Discord Discussion URL — will auto-close in 3 days p3 Low — nice to have rfc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants