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

Fix PR template #642

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix PR template #642

wants to merge 4 commits into from

Conversation

HarHarLinks
Copy link
Contributor

feel free to squash :)

Signed-off-by: Kim Brose 2803622+HarHarLinks@users.noreply.github.com

@HarHarLinks HarHarLinks requested a review from a team as a code owner February 12, 2023 22:47
Copy link
Contributor

@jaller94 jaller94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that the new relative URL is any better.
It depends a lot on how one accesses the repo.

@@ -1,3 +1,3 @@
<!--
Hi there 👋, please check you've read the [CONTRIBUTING](../CONTRIBUTING.md) guide before submitting a PR (it's worth it, honestly).
Hi there 👋, please check you've read the [CONTRIBUTING](../blob/main/CONTRIBUTING.md) guide before submitting a PR (it's worth it, honestly).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not work when I'm creating a PR on main...my-awesome-branch

Also, it does not get rendered as HTML anyway, because it's a comment.

Let's not link this in our template. For people who submit a PR for the first time, GitHub will show a notice with a link.

Suggested change
Hi there 👋, please check you've read the [CONTRIBUTING](../blob/main/CONTRIBUTING.md) guide before submitting a PR (it's worth it, honestly).
Hi there 👋, please check you've read the guide in CONTRIBUTING.md before submitting a PR (it's worth it, honestly).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not work when I'm creating a PR on main...my-awesome-branch

I'm not versed that part of GitHub magic, but I think that is because it's not merged to main yet?

Other than that, you're not wrong and I'm inclined to accept your suggestion.

Other repos such as synapse do:

<!-- Please read https://matrix-org.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request -->

which is a bit special since their docs are some web page. However I think usually people create PRs in the browser? So copy-pasting a link seems perhaps nicer than navigating manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants