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

Change the first heading in the pull request template to be useful #31

Open
mcdonnnj opened this issue Dec 15, 2021 · 0 comments
Open
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@mcdonnnj
Copy link
Member

mcdonnnj commented Dec 15, 2021

💡 Summary

Per #28 (review):

One thing I would like to see addressed is the octothorpe-wrapped comment at the very top of the PR template. All that line does is add a pointless horizontal line at the top of the PR, which I find maddening. We can't just remove the octothorpes, since then the linters complain that the first heading in the file isn't a first-level heading. We need to do one of the following:

  • Add something to that first-level heading, but I can't think of anything meaningful. The PR title is already handled by the PR web page, so it doesn't make sense to put it there.
  • Make the other headings all first-level headings, but that looks terrible.

Motivation and context

As the above remarks, the empty first heading in the pull request template is functionally useless at present.

@mcdonnnj mcdonnnj added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Dec 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

No branches or pull requests

1 participant