search

matrix-org / matrix-spec

The Matrix protocol specification
Apache License 2.0
188 stars 94 forks source link

Clean up pull request template #1831

Closed richvdh closed 4 months ago

richvdh commented 4 months ago

As far as I can tell, these header lines only encourage people to create badly-formatted PRs.

Also we only have one template so let's give it the default name.

Preview: https://pr1831--matrix-spec-previews.netlify.app

erikjohnston commented 4 months ago

Do you have an example of what this looks like? When I try and make a PR currently it seems to just give an empty box :/

richvdh commented 4 months ago

The thing I'm trying to fix is stuff like https://github.com/matrix-org/matrix-spec/pull/1830.

tulir commented 4 months ago

When I try and make a PR currently it seems to just give an empty box :/

I think that's because github's web UI doesn't support having multiple (named) PR templates, so when there's no default, it just doesn't show a template at all.

GitHub CLI does support those named templates, but it doesn't support the metadata section at the beginning

sumnerevans commented 4 months ago

I wasn't really sure what to put in that section, but it just keeps showing up whenever I do gh pr create which is the main way that I create PRs. It didn't really make sense to just copy the title and description that I already had written, so I just left it.

(I thought that it might be some sort of automation or accounting that was needed by some sort of process for the repo, so I just left it.)