Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve PULL_REQUEST_TEMPLATE.md #13727

Merged
merged 2 commits into from
May 31, 2024

Conversation

andersonjeccel
Copy link
Contributor

Q A
Bug fix? (use the a.b branch) 🔴
New feature/enhancement? (use the a.x branch) 🟢
Deprecations? 🔴
BC breaks? (use the c.x branch) 🔴
Automated tests included? 🔴
Related user documentation PR URL mautic/user-documentation#...
Related developer documentation PR URL mautic/developer-documentation-new#...
Issue(s) addressed Fixes #...

Description

This PR improves the template used for new pull requests. Specifically:

  • Adds emojis which can be used to fill the table answers (like the ones you're seeing here)
  • Adds an optional table for Before/After
  • Updates the documentation repositories URL
  • Improves the description section
Before After
image image

📋 Steps to test this PR:

  1. No testing needed?

@andersonjeccel andersonjeccel self-assigned this May 7, 2024
@andersonjeccel andersonjeccel added the enhancement Any improvement to an existing feature or functionality label May 7, 2024
Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.51%. Comparing base (aa4ac3c) to head (df6c17b).

Current head df6c17b differs from pull request most recent head 696335f

Please upload reports for the commit 696335f to get more accurate results.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##                5.x   #13727      +/-   ##
============================================
- Coverage     61.93%   61.51%   -0.43%     
+ Complexity    34196    34068     -128     
============================================
  Files          2249     2241       -8     
  Lines        102267   101852     -415     
============================================
- Hits          63337    62651     -686     
- Misses        38930    39201     +271     

see 48 files with indirect coverage changes

@abhisekmazumdar
Copy link
Contributor

The improved template looks easy to understand.

Copy link
Member

@npracht npracht left a comment

Choose a reason for hiding this comment

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

Copy link
Sponsor Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@RCheesley RCheesley merged commit 1867e18 into mautic:5.x May 31, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any improvement to an existing feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants