Skip to content

Conversation

@ArturVargas
Copy link
Contributor

@ArturVargas ArturVargas commented Jan 7, 2026

Description

This PR adds two simple issue templates to help contributors and users report bugs and propose features more effectively:

  1. Bug Report template - Guides users to report bugs with essential information (description, steps to reproduce, expected/actual behavior, environment details)
  2. Feature Request / Contribution template - Helps contributors propose new features or contributions with clear structure (description, motivation, proposed solution, affected workspaces)

Both templates:

  • Include security warnings aligned with contribute.md guidelines (no public security issues)
  • Reference contribute.md for complex features workflow
  • Use minimal required fields to reduce friction
  • Auto-apply appropriate labels (bug/enhancement)
  • Are designed to be simple and non-intrusive

The templates follow GitHub's standard format and are placed in .github/ISSUE_TEMPLATE/ directory.

Tested

  • Manually reviewed template content to ensure alignment with contribute.md guidelines:
    • Security vulnerability warning in bug report template
    • Complex features guidance in feature request template
  • Tested template rendering by pushing to a fork and verifying templates appear in GitHub's "New Issue" interface
  • Confirmed templates work correctly when issues are enabled in the repository

How to QA

  1. Verify templates appear in GitHub:

    • Navigate to the repository → Issues → New Issue
    • Should see two template options: "Bug Report" and "Feature Request / Contribution"
  2. Test Bug Report template:

    • Select "Bug Report"
    • Verify the security warning appears at the top
    • Fill out the form and check that:
      • Title prefix "[Bug]" is auto-applied
      • Label "bug" is automatically added
      • All sections render correctly
  3. Test Feature Request template:

    • Select "Feature Request / Contribution"
    • Verify the complex features note appears
    • Fill out the form and check that:
      • Title prefix "[Feature]" is auto-applied
      • Label "enhancement" is automatically added
      • Link to contribute.md works correctly
  4. Verify template files:

    • Check that both .github/ISSUE_TEMPLATE/*.md files exist
    • Confirm YAML frontmatter is properly formatted

Note

Introduces GitHub issue templates to standardize bug reports and feature/contribution requests.

  • Adds .github/ISSUE_TEMPLATE/bug_report.md with security vulnerability note, sections for repro/expected/actual/env, [Bug] title prefix, and bug label
  • Adds .github/ISSUE_TEMPLATE/feature_request.md with guidance for complex features linking to contribute.md, sections for description/motivation/solution, [Feature] title prefix, and enhancement label

Written by Cursor Bugbot for commit 6a06653. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Chores
    • Added standardized GitHub issue templates for bug reports and feature requests to streamline the contribution process and ensure consistent information gathering from the community.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2026

📝 Walkthrough

Walkthrough

Two new GitHub issue templates are added to standardize bug reports and feature requests. The templates include YAML front matter for metadata (name, title, labels, assignees) and structured sections with guidance text to guide contributors through the reporting process.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md
Added two issue templates with YAML front matter and structured sections. Bug Report template includes: Description, Steps to Reproduce, Expected Behavior, Actual Behavior, Environment, Additional Context, and security notice. Feature Request template includes: Description, Motivation, Proposed Solution, Workspace, and Additional Context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • aaronmgdr

Poem

📋✨ A tidy template's gift,
Bug reports and features take flight,
Issues now structured just right—
Contributor clarity shifts. 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding GitHub issue templates for bug reports and feature requests.
Description check ✅ Passed The description comprehensively covers all required sections: clear description of changes, testing approach, and detailed QA instructions for verification.
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.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e01b3c and 6a06653.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-25T19:19:04.954Z
Learnt from: CR
Repo: selfxyz/self PR: 0
File: app/AGENTS.md:0-0
Timestamp: 2025-12-25T19:19:04.954Z
Learning: Document complex native module changes in PRs

Applied to files:

  • .github/ISSUE_TEMPLATE/bug_report.md
🪛 markdownlint-cli2 (0.18.1)
.github/ISSUE_TEMPLATE/bug_report.md

25-25: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (2)
.github/ISSUE_TEMPLATE/bug_report.md (1)

1-37: LGTM! The bug report template is well-structured with clear sections and an appropriate security warning. The YAML frontmatter is correct, and the "[Bug]" title prefix and "bug" label will help with issue triage.

The static analysis hint about line 25 (MD036) appears to be a false positive—"## Actual Behavior" uses proper heading syntax and is not emphasis markup. This can be safely ignored.

.github/ISSUE_TEMPLATE/feature_request.md (1)

1-29: LGTM! The feature request template is well-designed and appropriately guides contributors toward the contribution workflow outlined in contribute.md. The guidance note on line 9 effectively directs complex features to discussion before development, reducing wasted effort.

The use of "optional" markers on secondary fields (Proposed Solution, Workspace) strikes the right balance between gathering useful context and minimizing friction for first-time contributors. The "[Feature]" title prefix and "enhancement" label will aid in classification.


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.

@transphorm
Copy link
Member

nice work!

Copy link
Member

@transphorm transphorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! thanks

@transphorm transphorm merged commit ba8aace into selfxyz:dev Jan 12, 2026
13 of 14 checks passed
jcortejoso pushed a commit that referenced this pull request Jan 15, 2026
* Add issue templates for bug reports and feature requests

* Remove test script from PR (not needed for issue templates)
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.

2 participants