-
Notifications
You must be signed in to change notification settings - Fork 1
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
docs: add a PR template #391
Conversation
|
Note: the table is now weirdly mis-aligned when you look at it in fixed font, but that makes it roughly align in the default view you get when you use it to submit a PR, since GH uses a variable-font editor. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #391 +/- ##
==========================================
- Coverage 73.15% 71.81% -1.34%
==========================================
Files 43 43
Lines 2786 2973 +187
Branches 459 520 +61
==========================================
+ Hits 2038 2135 +97
- Misses 664 749 +85
- Partials 84 89 +5 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just one comment, thanks @joanise !
.github/pull_request_template.md
Outdated
| Q | A | ||
| ----------------- | --- | ||
| Goal? | <!-- Explain the main objective of this PR. --> | ||
| Fixes? | `Fixes #1, Fixes #2` <!-- Remove the (`) quotes and write "Fixes" before the number to link the issues. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the pipes are not aligned here - can we format it so that even in the raw text format they appear aligned? Also I think we can expand Q and A to "Question" and "Answer since we have space.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we align them in fixed width, they look like this in the PR comment editor:
What I did here was align them as best as I could in the PR comment editor, so now they look ugly in the fixed width view. I don't know how to make it align OK in both views.
Agreed for spelling Question and Answer in full.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
8973cb3
to
0059da2
Compare
Rewritten with visible headings instead of a table that I can't get to align nicely. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great - thanks for continuing to wrestle with the formatting @joanise !
Do you think this PR should trigger a Major (Breaking Change)/Minor (New Feature)/patch (refactor/bug fix) version change? No