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

Skip to content

[Doc]: code-of-conduct URL in git repository may be outdated #27834

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

Closed
jayaddison opened this issue Feb 28, 2024 · 3 comments
Closed

[Doc]: code-of-conduct URL in git repository may be outdated #27834

jayaddison opened this issue Feb 28, 2024 · 3 comments

Comments

@jayaddison
Copy link
Contributor

jayaddison commented Feb 28, 2024

Documentation Link

https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md

Problem

The GitHub Actions bot sends notifications to first-time contributors about the code-of-conduct, and the URL that it links to is:

https://matplotlib.org/stable/project/code_of_conduct.html

(see here for an example comment by the bot)

The linked URL is a markdown file that links to the current code-of-conduct as hosted on the matplotlib.org website.

The correct/expected URL appears to be: https://matplotlib.org/stable/users/project/code_of_conduct.html

Currently the markdown file links to: https://matplotlib.org/stable/project/code_of_conduct.html (HTTP 404)

Suggested improvement

Either:

  • The CODE_OF_CONDUCT.md file should be edited to use the URL that includes /users/ in the path.

or

  • The website should be updated so that the URL without /users/ in the path displays the code-of-conduct.

Edit: fix incorrect hyperlinks in this issue's description.

@jayaddison jayaddison changed the title [Doc]: code-of-conduct URL in git repository is outdated [Doc]: code-of-conduct URL in git repository may be outdated Feb 28, 2024
@story645
Copy link
Member

story645 commented Feb 29, 2024

The CODE_OF_CONDUCT.md file should be edited to use the URL that includes /users/ in the path.

This should work since the redirects will make the URL w/ this work too once the website is updated. (This issue is a side effect of #27560)

@jayaddison
Copy link
Contributor Author

The CODE_OF_CONDUCT.md file should be edited to use the URL that includes /users/ in the path.

This should work since the redirects will make the URL w/ this work too once the website is updated. (This issue is a side effect of #27560)

Great, thank you. I notice the redirect-from entry for the page in the pull request, and will wait for the website update.

(I'll check again occasionally to make sure it works as expected after the update, but I think this bug can be closed)

@jayaddison jayaddison closed this as not planned Won't fix, can't repro, duplicate, stale Feb 29, 2024
@jayaddison
Copy link
Contributor Author

I can confirm that the relevant code-of-conduct hyperlink does now function as expected following the mentioned updates that were applied to the Matplotlib website. Thank you!

PS: while checking that, I noticed that a hyperlink in the description I wrote for this issue itself -- the hyperlink to a sample GitHub comment by the bot -- was incorrect; I'll update that in a few moments.

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

No branches or pull requests

2 participants