Add some more guidance to issue template #6692
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6692 +/- ##
=======================================
Coverage 98.61% 98.61%
=======================================
Files 79 79
Lines 14559 14559
=======================================
Hits 14358 14358
Misses 201 201 ☔ View full report in Codecov by Sentry. |
| Some general advice on the title and description fields for your PR | ||
|
|
||
| - Please don't tag your issue with text in the title like '[Joins]'; project members will add the appropriate tags later. | ||
| - Don't write text like 'Closes #xxx' in the PR title either; GitHub does not recognize this text, whereas GitHub auto-links issues in the description, [see docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). |
There was a problem hiding this comment.
maybe change to: ... auto-links issues in the description (first PR comment), ...
There was a problem hiding this comment.
I see what you mean -- "description" might not be well-understood.
However, I think "first PR comment" is even more ambiguous -- "first PR comment" to me is the first comment after the description.
Given that we immediately link to GitHub's own documentation, I would leave this as-is -- better to let GitHub describe their own terminology. I filed github/docs#35804 for that.
No description provided.