Skip to content

.Github - Pull Request Templates: Setup #182

@lechitz

Description

@lechitz

General Information

  • Category: docs
  • Priority: high

Description

Implement standardized Pull Request templates to enforce consistency and quality across contributions in AionAPI.

This task aims to add PR templates that match the project’s workflow, focusing on features, bugfixes, and refactors. These templates will ensure contributors always provide the necessary context, validation details, and observability updates.


Acceptance Criteria

  • Create folder .github/PULL_REQUEST_TEMPLATE/

  • Add feature.md:

    • Summary, Linked Issues, Implementation Notes, Observability checklist
  • Add bugfix.md:

    • Bug description, Steps to reproduce, Fix details, Regression tests
  • Add refactor.md:

    • Refactor scope, Reason (tech debt/performance), Validation, Risks
  • Ensure GitHub displays the template selection menu when opening a new PR

  • Align tone and structure with existing issue templates for consistency

  • Verify Community Standards now detects Pull Request template as complete


Notes

  • GitHub allows automatic loading of a single template (.github/pull_request_template.md) or multiple selectable templates in PULL_REQUEST_TEMPLATE/.

  • Using multiple templates provides flexibility:

    • Feature PRs: emphasize new functionality and observability.
    • Bugfix PRs: emphasize reproduction and validation.
    • Refactor PRs: emphasize scope and safety.

Metadata

Metadata

Assignees

Labels

featureNew feature or request.

Projects

Status

BACKLOG

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions