Skip to content

Proposal: Introduce a PR Template for Contributors #3409

Closed
@SinghaAnirban005

Description

@SinghaAnirban005

Is your feature request related to a problem? Please describe the impact that the lack of the feature requested is creating.

Currently, there is no standardized pull request template in the Headlamp repository. This can lead to inconsistent PR descriptions, missing context, or lack of clarity around testing steps and related issues. New contributors may be unsure about what information to include, and maintainers might need to request follow-up changes for context that could have been provided upfront.

Describe the solution you'd like

I would like to propose the addition of a .github/pull_request_template.md file to the repository. This template would guide contributors to provide:

  1. A brief summary of the changes
  2. Related issue links
  3. A clear breakdown of changes made
  4. Steps to test the changes
  5. Any screenshots (if applicable)
  6. Additional context for maintainers

This would improve the consistency and quality of PRs and help both contributors and reviewers save time.

What users will benefit from this feature?

  1. All contributors to the Headlamp project (especially new contributors)
  2. Maintainers and reviewers who benefit from consistent and complete PR context

Are you able to implement this feature?

Yes (I will propose a PR)

Do you want to help implement this feature? Please see our contribution docs. For any non-trivial contributions, we advise you to join our our slack channel to discuss the implementation with Headlamp's core developers.

Additional context

[If needed, add any other context or screenshots about the feature request here.]

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions