Skip to content

Fix(PR template): enhance readability, go straight to the point#894

Merged
Marc-Andrieu merged 2 commits intomainfrom
fix/pr-template-readability
Nov 9, 2025
Merged

Fix(PR template): enhance readability, go straight to the point#894
Marc-Andrieu merged 2 commits intomainfrom
fix/pr-template-readability

Conversation

@Marc-Andrieu
Copy link
Member

@Marc-Andrieu Marc-Andrieu commented Nov 9, 2025

Description

Summary

  • The other day I created a Hyperion PR and I was lost in the template: I was drowned in too much text by default.
  • Also, some ppl definitely didn't read the instructions, also drowned in text.
  • Thirdly, there was a spacing bug in the classification that rendered it way to spaced between checkboxes

Issues/PR dependencies

Issues to be resolved

Required PRs

Changes Made

  • Comments are shorter, and go straight to the insctructions
  • Fix spacing bug (basically don't jump lines in markdown lists)
  • Factorize isssues/PR dependencies
  • Use bigger fonts to retrieve the section you want

Additional Notes

Here I'm using the enhanced PR template, so you can have a feel of what it looks like (both in code and rendered)

Classification

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 🔨 Refactor (non-breaking change that neither fixes a bug nor adds a feature)
  • 🔧 Infra CI/CD (changes to configs of workflows)
  • 💥 BREAKING CHANGE (fix or feature that require a new minimal version of the front-end)
  • 😶‍🌫️ No impact for the end-users

Impact & Scope

  • Core functionality changes
  • Single module changes
  • Multiple modules changes
  • Database migrations required
  • Other: PR template

Testing

  • 1. Tested this locally
  • 2. Added/modified tests that pass the CI (or tested in a downstream fork)
  • 3. Tested in a deployed pre-prod
  • 0. Untestable (exceptionally), will be tested in prod directly

Documentation

  • Updated the docs accordingly :
  • " Docstrings
  • # Inline comments
  • No documentation needed

@Marc-Andrieu Marc-Andrieu requested a review from warix8 November 9, 2025 12:30
@Marc-Andrieu Marc-Andrieu self-assigned this Nov 9, 2025
@Marc-Andrieu Marc-Andrieu added enhancement New feature or request ready for review This PR is ready to be reviewed labels Nov 9, 2025
@codecov
Copy link

codecov bot commented Nov 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.89%. Comparing base (7dd1602) to head (ad5bd36).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #894   +/-   ##
=======================================
  Coverage   85.89%   85.89%           
=======================================
  Files         193      193           
  Lines       14953    14953           
=======================================
  Hits        12844    12844           
  Misses       2109     2109           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Marc-Andrieu Marc-Andrieu merged commit f977db1 into main Nov 9, 2025
16 checks passed
@Marc-Andrieu Marc-Andrieu deleted the fix/pr-template-readability branch November 9, 2025 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ready for review This PR is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant