Skip to content

Use headings in pull request template#2

Merged
james-rms merged 1 commit intomainfrom
jrms/use-headings
Mar 2, 2023
Merged

Use headings in pull request template#2
james-rms merged 1 commit intomainfrom
jrms/use-headings

Conversation

@james-rms
Copy link
Copy Markdown
Contributor

@james-rms james-rms commented Mar 1, 2023

Public-Facing Changes

Description

@james-rms james-rms requested a review from amacneil March 1, 2023 01:15
@amacneil
Copy link
Copy Markdown
Contributor

amacneil commented Mar 1, 2023

I personally find h2 pretty aggressive. Also not sure we want to mention linear in our PR template given that OSS folks see it?

@defunctzombie can make a call on this, I am not in github enough

fyi I edited this PR description to use the template, as an example

@defunctzombie
Copy link
Copy Markdown
Contributor

I agree - the h2 are rather aggressive. h3 maybe? That still provides h4, and h5 for use by the author? I am 👍 On changing these to headers away from "bold". Here was the original discussion: https://github.com/foxglove/console/pull/2047

FWIW when you actually merge the PR the styling does not display anymore in the github UI. Don't think that changes my feelings here, only wanted to surface this: foxglove/studio@1d518e9

And yes please remove Linear from the template. I don't include linear issues in the description when I use the branch name from linear since that part is handled automatically by linear so unless I am referencing a GitHub issue as well I don't add any additional references. I think the commented out reminder is sufficient.

* also call out linear issues as well as github issues.
@james-rms james-rms force-pushed the jrms/use-headings branch from 530479e to 095678d Compare March 2, 2023 19:11
@james-rms james-rms merged commit 3043a13 into main Mar 2, 2023
@defunctzombie defunctzombie deleted the jrms/use-headings branch March 2, 2023 19:27
@jtbandes
Copy link
Copy Markdown
Member

jtbandes commented Mar 8, 2023

Should we remove https://github.com/foxglove/studio/blob/main/.github/pull_request_template.md?plain=1 so that this also gets used for studio? Or is it intentional that they're different? cc @esthersweon

@esthersweon
Copy link
Copy Markdown

esthersweon commented Mar 8, 2023

@jtbandes – Not intentional. We can use this one template for Studio.

Would want to add the following comments then in this template:

  • Add a docs label if this change requires documentation updates
  • Use relevant metric tracking to assess the performance of new and experimental features

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

5 participants