Thanks to visit codestin.com
Credit goes to github.com

Skip to content

GitHub: Fix link to Contributing Guidelines #129

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

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

callahad
Copy link
Contributor

@callahad callahad commented Sep 6, 2024

Absolute paths in links end up being rooted at github.com.

The contributing guidelines link is broken unless we use the full URL.

Also, remove superfluous monospace formatting for the link.

@callahad callahad force-pushed the contributing branch 2 times, most recently from db3721a to 0fcc38c Compare September 6, 2024 16:05
@callahad
Copy link
Contributor Author

callahad commented Sep 6, 2024

You can see the broken before state in #123

Before creating a pull request, make sure to comply with
[`Contributing Guidelines`](/CONTRIBUTING.md).
Before creating a pull request, make sure to comply with the
[Contributing Guidelines](https://github.com/nginx/nginx/blob/master/CONTRIBUTING.md).

Choose a reason for hiding this comment

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

Suggested change
[Contributing Guidelines](https://github.com/nginx/nginx/blob/master/CONTRIBUTING.md).
[Contributing Guidelines](./CONTRIBUTING.md).

a relative link would be better imo, so it always references the same revision when browsing older ones

Copy link
Contributor Author

@callahad callahad Sep 6, 2024

Choose a reason for hiding this comment

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

I agree, but will that work? GitHub seems really inconsistent with how it handles paths in Markdown links across different parts of the site.

(E.g., the rendered diff for this patch handles /CONTRIBUTING.md differently from how it handles it in PR bodies, as you can see in #123.)

I spot checked this against a few other major open source projects (nixpkgs, homebrew) and they all seem to use fully expanded URLs.

Choose a reason for hiding this comment

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

You are correct, it does not. Sorry.
I didn't realize this was a pull request template.
I probably shouldn't review random PRs I stumble over while being tired 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review either way! It's good to get this written down :)

Copy link
Contributor

@Maryna-f5 Maryna-f5 left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for updating the link!

Absolute paths in links end up being rooted at github.com.
The contributing guidelines link is broken unless we use the full URL.
Also, remove superfluous "monospace formatting" for the link.
@Maryna-f5 Maryna-f5 merged commit 36ca44f into nginx:master Nov 12, 2024
1 check passed
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.

3 participants