Skip to content

chore(github): update issue templates and add PR template#436

Merged
nanotaboada merged 2 commits intomasterfrom
chore/update-github-templates
Mar 29, 2026
Merged

chore(github): update issue templates and add PR template#436
nanotaboada merged 2 commits intomasterfrom
chore/update-github-templates

Conversation

@nanotaboada
Copy link
Copy Markdown
Owner

@nanotaboada nanotaboada commented Mar 29, 2026

Summary

  • Updated feature_request.md and bug_report.md: removed forced bracket prefixes from titles, relying on labels (enhancement, bug) for categorization instead
  • Fixed inconsistent language labels on bug_report.md across repos (go, python, typescript were missing)
  • Made Suggested Approach optional in feature_request.md; replaced generic criteria placeholders with meaningful defaults
  • Added config.yml to disable blank issues (enforces template usage)
  • Added pull_request_template.md with type-of-change checklist aligned to Conventional Commits types
  • Added ### Creating Issues section to copilot-instructions.md documenting the SDD workflow (Plan → Issue → implement) and the expected structure for both template types

Test plan

  • Verify the issue template chooser shows only Bug report and Feature request (no blank option)
  • Open a new issue and confirm title is empty, labels are pre-filled, and Suggested Approach is marked optional
  • Open a new PR and confirm the template is pre-filled

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated bug report and feature request templates with improved acceptance criteria and clearer guidance.
    • Added structured pull request template with sections for change categorization and review checklist.
  • Chores

    • Enhanced GitHub workflow configuration to disable blank issue submissions.
    • Updated developer guidelines for consistent issue tracking and development workflow.

nanotaboada and others added 2 commits March 29, 2026 13:34
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f32ddba4-5fb4-4ad8-82b0-c1f0818e8b19

📥 Commits

Reviewing files that changed from the base of the PR and between b2ec848 and a9e5ab8.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/copilot-instructions.md
  • .github/pull_request_template.md

Walkthrough

GitHub repository workflow configuration updated across five files: issue templates modified to remove preset titles and restructure sections, issue creation disabled for blank submissions, Copilot instructions extended with Spec-Driven Development guidelines and issue template specifications, and a new pull request template introduced with structured PR sections and checklist items.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, .github/ISSUE_TEMPLATE/config.yml
Bug report and feature request templates have their title front-matter fields cleared; config file disables blank issue creation; feature request acceptance criteria updated from generic placeholders to specific behavior, coverage, and regression criteria; "Suggested Approach" section marked optional.
Development Workflow Guidance
.github/copilot-instructions.md, .github/pull_request_template.md
Copilot instructions augmented with "Creating Issues" SDD flow and structured issue templates for enhancement and bug labels; new PR template introduced with summary, change-type checkboxes, and completion checklist covering changelog updates, test execution, and code guidelines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title follows Conventional Commits format (chore:), is concise at 57 characters (under 80), and accurately describes the main changes: updating issue templates and adding a PR template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-github-templates
  • 🛠️ sync documentation: Commit on current branch
  • 🛠️ sync documentation: Create PR
  • 🛠️ enforce http error handling: Commit on current branch
  • 🛠️ enforce http error handling: Create PR
  • 🛠️ idiomatic review: Commit on current branch
  • 🛠️ idiomatic review: Create PR
  • 🛠️ verify api contract: Commit on current branch
  • 🛠️ verify api contract: Create PR

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 and usage tips.

@sonarqubecloud
Copy link
Copy Markdown

@nanotaboada nanotaboada merged commit 2b84c0b into master Mar 29, 2026
9 checks passed
@nanotaboada nanotaboada deleted the chore/update-github-templates branch March 29, 2026 17:18
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