Skip to content

CONTRIBUTING.md: Clarify the PR description section#8592

Closed
easwars wants to merge 1 commit intogrpc:masterfrom
easwars:clarify_pr_description
Closed

CONTRIBUTING.md: Clarify the PR description section#8592
easwars wants to merge 1 commit intogrpc:masterfrom
easwars:clarify_pr_description

Conversation

@easwars
Copy link
Copy Markdown
Contributor

@easwars easwars commented Sep 18, 2025

This change adds more details to the "PR description" section and hopefully makes it easier for contributors to add PR titles and description that meets our requirements.

RELEASE NOTES: n/a

@easwars easwars requested a review from dfawley September 18, 2025 19:19
@easwars easwars added Type: Meta Github repo, process, etc Type: Documentation Documentation or examples and removed Type: Meta Github repo, process, etc labels Sep 18, 2025
@easwars easwars added this to the 1.77 Release milestone Sep 18, 2025
@easwars easwars force-pushed the clarify_pr_description branch from 279547b to 0ea02fd Compare September 18, 2025 19:23
@codecov
Copy link
Copy Markdown

codecov bot commented Sep 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.96%. Comparing base (e8ad657) to head (0ea02fd).
⚠️ Report is 157 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8592      +/-   ##
==========================================
+ Coverage   81.91%   81.96%   +0.04%     
==========================================
  Files         415      415              
  Lines       40694    40694              
==========================================
+ Hits        33336    33355      +19     
+ Misses       5968     5956      -12     
+ Partials     1390     1383       -7     

see 18 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dfawley dfawley assigned easwars and unassigned dfawley Oct 1, 2025
@dfawley
Copy link
Copy Markdown
Member

dfawley commented Oct 1, 2025

As discussed offline, I am weary to add 20 lines to this already long document. Maybe we can solve our problems by providing a better template that includes the fields we want to see in the order we want to see them? E.g.

Fixes|Updates: #<issue>

A description of the change being made.  If fixing a bug, please include a brief description of the bug and/or how it is triggered.  Include any necessary explanation of alternatives considered/etc.

All changes must include either:

RELEASE NOTES:
* <component>: <user-understandable explanation of the change being made>

OR for non-user-visible changes:

RELEASE NOTES: n/a

@easwars
Copy link
Copy Markdown
Contributor Author

easwars commented Feb 3, 2026

I don't have the cycles to get this to the finish line at this point in time. Closing this now and will reopen when I can actually work on this.

@easwars easwars closed this Feb 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Documentation or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants