Skip to content

Conversation

@IamLRBA
Copy link
Contributor

@IamLRBA IamLRBA commented Jun 25, 2025

Description

This PR adds standardized GitHub templates to improve issue and pull request submissions.

Related Issue

Closes #866

Motivation and Context

  • Standardizes issue/PR submissions for better maintainability.
  • Guides contributors with clear templates (reducing back-and-forth).
  • Follows best practices from awesome-github-templates.

Changes Made

  1. Created .github/ISSUE_TEMPLATE/ with:
    • bug_report.md
    • feature_request.md
    • documentation_improvement.md
  2. Added root-level PULL_REQUEST_TEMPLATE.md

Testing

  • Verified templates render correctly in a test repo.
  • Checked all links (e.g., CONTRIBUTING.md) for accuracy.

Screenshots (Preview)

(Optional: Add a screenshot of how the templates appear in GitHub’s UI)

Checklist

  • My changes follow the project’s code style.
  • I’ve linked the related issue above.
  • I’ve tested the templates functionally.
  • Documentation not needed (meta-change).

cc
@benoit-cty

@benoit-cty benoit-cty requested a review from Copilot June 25, 2025 06:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces standardized GitHub issue and pull request templates to improve consistency and clarity in submissions. The key changes include adding templates for bug reports, feature requests, and documentation improvement, along with a dedicated pull request template that includes sections for description, testing, and checklists.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.github/PULL_REQUEST_TEMPLATE.md New pull request template outlining description, issue linkage, testing, and checklists.
.github/ISSUE_TEMPLATE/feature_request.md Template for feature requests, guiding users to provide problem details and solution suggestions.
.github/ISSUE_TEMPLATE/documentation_improvement.md Template for suggesting documentation improvements with clear context fields.
.github/ISSUE_TEMPLATE/bug_report.md Template for bug reports including reproduction steps and expected behavior.
.github/ISSUE_TEMPLATE.md Legacy issue template removed in favor of dedicated templates.
Comments suppressed due to low confidence (1)

.github/ISSUE_TEMPLATE/feature_request.md:4

  • Consider adding a placeholder in the 'title' field (for example, 'Feature Request: ...') to guide contributors on how to format their feature request titles.
title: ''

Copy link
Contributor

@benoit-cty benoit-cty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, thank you !

@benoit-cty benoit-cty merged commit 03e772d into mlco2:master Jun 25, 2025
5 checks passed
@IamLRBA
Copy link
Contributor Author

IamLRBA commented Jun 26, 2025

Very nice, thank you !

Glad to work sir! 🫡

@benoit-cty benoit-cty mentioned this pull request Jul 11, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a template for Issues and PR

2 participants