Skip to content

docs(contributing): agree on a feature before building it, and the bar it meets - #1139

Merged
devswha merged 1 commit into
mainfrom
docs/feature-pr-bar
Oct 14, 2026
Merged

devswha merged 1 commit into
mainfrom
docs/feature-pr-bar

Conversation

@devswha

@devswha devswha commented Oct 14, 2026

Copy link
Copy Markdown
Owner

Change

Feature proposals often arrive as an issue and a finished PR on the same day (#880/#892, #1082/#1083), so the existing "open an issue first" line does not stop work that ends up declined. This states the bar up front:

  • CONTRIBUTING.md: a feature waits for a maintainer's yes on its feature request; a feature PR without one may be closed. A feature should mirror something herdr's own TUI does, or meet a need that widely used coding-agent apps (the Codex and Claude apps, Paseo, T3 Code and the like) already meet. A convenience none of them offers, or a new setting or UI concept for a narrow case, is likely to be declined.
  • Feature request template: the same note at the top, and a required "Where it exists today" field (herdr's TUI, another coding-agent app, or none).
  • PR template: a feature links the issue where a maintainer agreed to it.

No user-facing change, so no changelog fragment.

Validation

  • The issue template parses as YAML.
  • scripts/conventions.test.ts and scripts/changelog-fold.test.ts pass.

🤖 Generated with Claude Code

…r it meets

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: devswha/herdr-web-ui/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4427e7dc-d1ff-4e1d-9026-eca475db071d
📥 Commits

Reviewing files that changed from the base of the PR and between 525cdcf and 4e9db05.

📒 Files selected for processing: 3
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated feature-request guidance to ask contributors to describe where a proposed feature is available today and to obtain maintainer approval before coding.
    • Clarified that feature proposals should align with the app’s existing interface or address needs already met by widely used coding-agent apps.
    • Updated the pull request template to request a link to the approved feature request.

Feature contribution guidance now asks contributors to seek maintainer approval before implementation. The feature request template asks where the proposed feature exists today. The pull request template asks contributors to link the approved issue.

Changes: Feature Contribution Guidance

Layer / File(s) Summary
Feature proposal and approval requirements
.github/ISSUE_TEMPLATE/feature_request.yml, CONTRIBUTING.md, .github/pull_request_template.md
The feature request template and contribution guide describe maintainer approval and which feature proposals fit the project’s stated criteria. The template also asks where the feature exists today. The pull request template asks for a link to the approved issue.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 4e9db

The changes clarify how feature proposals are approved and linked to PRs. No actionable merge risk was identified.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Title check Passed The title clearly summarizes the main change: requiring agreement on feature work and defining the acceptance bar.
Description check Passed The description includes the required Change and Validation sections. It explains the problem, resulting documentation changes, validation results, and changelog decision.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@devswha
devswha merged commit fe5aeb9 into main Oct 14, 2026
9 checks passed
@devswha
devswha deleted the docs/feature-pr-bar branch October 14, 2026 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant