Skip to content

Implement Standardized GitHub Issue Templates #62

@Nitya-003

Description

@Nitya-003

Description

To improve project maintainability and streamline open-source contributions, MicroForge needs standardized GitHub Issue Templates. Currently, the repository lacks a structured way for users to report bugs or suggest features, which is a key requirement for enterprise-grade documentation and repository health.

Proposed Changes

Create a .github/ISSUE_TEMPLATE/ directory containing the following templates:

  1. Bug Report (bug_report.md):
    • Fields for service identification (Go, Java, Python, etc.).
    • Sections for environment details (Docker vs. Kubernetes).
    • Placeholders for container logs and reproduction steps.
  2. Feature Request (feature_request.md):
    • Sections for the "Why" and "How."
    • Technology stack proposal for new polyglot services.
  3. Documentation Template (documentation.md):
    • A checklist-style template for tracking general improvements or README updates (like the Mermaid.js integration).

Why this is needed?

  • Consistency: Ensures all technical issues contain the necessary logs and environment context.
  • Professionalism: Aligns the repository with industry-standard DevOps and OSS practices.
  • Efficiency: Reduces the back-and-forth communication needed to debug issues across the 5+ microservices.

Tasks

  • Create .github/ISSUE_TEMPLATE directory.
  • Add bug_report.md.
  • Add feature_request.md.

I love to work on this issue and Submit a PR.

Labels: SWOC, SWOC'26

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions