Skip to content

Setup community health files: Issue templates, labels, and workflow configurations #42

Description

@RaulSMS

Context

As our project grows, we want to make it as easy and seamless as possible for the community to contribute high-quality code and feedback. Currently, we lack standardized issue types, which can lead to incomplete bug reports or unstructured feature requests. Setting up standardized templates and explicit labels will help automate our triage process and guide contributors.

Objectives

We need to introduce a core set of standard issue templates, pull request templates, and a clean label taxonomy to organize the repository.

Proposed Structure

1. Issue Templates (.github/ISSUE_TEMPLATE/)

We should create YAML-based issue forms to ensure consistency:

  • Bug Report: Includes steps to reproduce, expected vs. actual behavior, environment details (OS, Python version, hardware interface), and log/CAN trace snippets.
  • Feature Request: Includes the problem statement, the proposed solution, and alternative solutions considered.
  • Task / Refactor: A simplified template for internal maintenance, documentation updates, or structural changes.

2. Pull Request Template (.github/pull_request_template.md)

A template ensuring every PR provides:

  • A reference to the issue it resolves (e.g., Closes #12).
  • A brief description of the implementation.
  • A checklist for the contributor (tests added, documentation updated, code formatted).

3. Standardized Label Taxonomy

A foundational set of color-coded labels categorized by function:

  • Type: type: bug, type: feature, type: documentation, type: refactor
  • Status: status: triage, status: in-progress, status: blocked
  • Difficulty/Scope: good first issue, help wanted

Definition of Done

  • Issue forms for Bugs, Features, and Tasks are active under .github/ISSUE_TEMPLATE/.
  • A universal default PR template is merged.
  • The standard GitHub label set is updated and documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions