converted coc to rst and put links in code_of_conduct.md #26702
Conversation
|
Unfortunately, I think we need this file for GitHub's purposes, unless it understands the redirect you've added. |
|
Yeah that's what I'm trying to figure out, if GitHub needs the full file or if a placeholder will work - either redirect or a page saying "CoC is at link" |
|
For good or bad, github just needs that file to exist-it does not care about the contents at all: https://github.com/story645/scraps/tree/master You're right about the forwarding not working, so I'll switch to something similar to https://github.com/matplotlib/matplotlib/blob/main/INSTALL.rst but as a link. I still think though that it's better for the CoC to be properly situated in the docs. Also looks like I just did the redirecting wrong. |
|
A nice follow up to this is that we can put the "here's the link to our coc" code_of_conduct.md in all the matplotlib repos and have everything resolve to the one code of conduct. |
| .. code_of_conduct | ||
|
|
||
| ==================================== | ||
| Contributor Covenant Code of Conduct |
There was a problem hiding this comment.
Orthogonal to this PR, but came up because you needed a modified entry in the TOC:
Is this the "Contributor Covenant" code of conduct, or is it " adapted from the Contributor Covenant "?
This headline is missing punctuation or something because "Contributor Covenant Code of Conduct" doesn't mean anything in plain English, and only makes sense if you know what "Contributor Covenant" is, which we don't explain until the bottom.
On-topic: I don't see what is wrong with moving this, but maybe some people don't want to click through?
There was a problem hiding this comment.
Contributor covenant code of conduct is the full name and I don't know if we can modify the title.
https://www.contributor-covenant.org/version/2/1/code_of_conduct/
Also possibly should add ourselves to their list of projects that have their CoC so I'll go do that.
And I think this + #26703 basically wraps up moving stuff into the docs proper, which I think will make it easier to spin stuff back out #22866 - basically pushing the CoC into the project parts of the docs and pointing all the code_of_conduct.md to the hosted CoC means the source of truth CoC can live in any repo - I could even see an argument for moving everything under users/project out into the governance repo.
|
My instinct is to say that this is a doc-only change that does not impact the release artifacts, we have the ability to update the docs decoupled from the release itself, and thus not to hold up releasing on this. That said, I can wait until the meeting today to tag, and that may mean we get it in anyway. |
…ode_of_conduct.md
Converted the CoC so that it could be integrated into our docs - it's current form as an md file makes it feel a bit out of place. Not totally sure this will work but tried using the git redirect template inside code_of_conduct.md to keep the coc link working. Any ideas to test would be great.