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 repo file links in the PR template #1363
Conversation
@@ -5,18 +5,18 @@ much about the checklist - we will help you get started. | |||
|
|||
## Contribution checklist: | |||
|
|||
(also see [CONTRIBUTING.rst](/CONTRIBUTING.rst) for details) | |||
(also see [CONTRIBUTING.rst](../tree/master/CONTRIBUTING.rst) for details) |
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.
seems ../CONTRIBUTING.rst
works as well (I just tried it by editing your PR)
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.
Interesting... I'm not sure how.
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.
https://github.com/tox-dev/tox/CONTRIBUTING.rst 404 Not Found for
me.
../CONTRIBUTING.rst
is relative to the current page https://github.com/tox-dev/tox/pull/1363
-> https://github.com/tox-dev/tox/pull/1363/../CONTRIBUTING.rst
-> https://github.com/tox-dev/tox/CONTRIBUTING.rst
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.
iirc github renders the markdown in a "context" relative to where the file sits -- so it knows that down one directory is the CONTRIBUTING.rst file (./.github/../CONTRIBUTING.rst
)
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.
Maybe you use some browser extension?
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.
oh what now it doesn't work, what did I do before 😕
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.
maybe you used some different view (like from the actual file page, not PR)? Also, there's some front-end caching here.
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.
Links in the PR template are broken. They start with
/
which effectively creates absolute URI paths relative tohttps://github.com
. So/CONTRIBUTING.rst
points tohttps://github.com/CONTRIBUTING.rst
, not to the file view under this repo.Fixes #1120.
See the broken template below (as rendered when I created this PR):
Contribution checklist:
(also see CONTRIBUTING.rst for details)
in message body
<issue number>.<type>.rst
for example (588.bugfix.rst)<type>
is must be one ofbugfix
,feature
,deprecation
,breaking
,doc
,misc
<your username>
"superuser
."CONTRIBUTORS
(preserving alphabetical order)