Skip to content

Create GitHub Issue and Pull Request Templates #28

@IamLRBA

Description

@IamLRBA

Description

This repository currently lacks standardized templates for Issues and Pull Requests. Adding templates would:

  • Improve consistency and clarity of submissions
  • Reduce back-and-forth for missing information
  • Make contributing more accessible for newcomers

Benefits

  • Follows GitHub's best practices
  • Similar to templates used by popular projects like React
  • Low maintenance once implemented

Proposed Solution

  1. Issue Templates in .github/ISSUE_TEMPLATE/:

    • bug_report.md (with reproduction steps, environment details)
    • feature_request.md (with use case, proposed solution)
    • documentation.md (for docs-related issues)
  2. Pull Request Template (.github/pull_request_template.md):

    • Description of changes
    • Related issues
    • Screenshots (if applicable)
    • Checklist for reviewers

Next Steps

I can:

  1. Submit sample templates for discussion, or
  2. Directly open a PR with basic templates if maintainers approve.

cc @andrewb1269hg @DJ-BBot @rbarker-dev

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions