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

converted coc to rst and put links in code_of_conduct.md #26702

Merged
merged 2 commits into from Sep 14, 2023

Conversation

story645
Copy link
Member

@story645 story645 commented Sep 6, 2023

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.

@story645 story645 added governance needs approval from @steering-council Documentation: website layout/behavior/styling changes labels Sep 6, 2023
@QuLogic
Copy link
Member

QuLogic commented Sep 6, 2023

Unfortunately, I think we need this file for GitHub's purposes, unless it understands the redirect you've added.

@story645
Copy link
Member Author

story645 commented Sep 6, 2023

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"

@story645
Copy link
Member Author

story645 commented Sep 6, 2023

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.

@story645 story645 changed the title converted coc to rst and added md forward rule converted coc to rst and put links in code_of_conduct.md Sep 6, 2023
@story645
Copy link
Member Author

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.

@story645
Copy link
Member Author

@QuLogic @ksunden - any chance to get this in for 3.8? Thinking especially w/ #26332 in that it'd be nice to have the CoC integrated into the project info docs.

I can also put this on the call - honestly not sure if folks would prefer a larger discussion around moving the CoC this way.

.. code_of_conduct

====================================
Contributor Covenant Code of Conduct
Copy link
Member

Choose a reason for hiding this comment

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

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?

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

@ksunden
Copy link
Member

ksunden commented Sep 14, 2023

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.

@ksunden ksunden added this to the v3.8.0 milestone Sep 14, 2023
@QuLogic QuLogic merged commit b8a42cf into matplotlib:main Sep 14, 2023
40 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 14, 2023
@story645 story645 deleted the coc branch September 14, 2023 20:51
@ksunden ksunden mentioned this pull request Sep 15, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: website layout/behavior/styling changes governance needs approval from @steering-council
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants