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

Add Mozilla Code of Conduct #4864

Conversation

Mozilla-GitHub-Standards
Copy link
Contributor

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

  1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
  2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please reach out to Mozilla-GitHub-Standards+CoC@mozilla.com.

(Message COC002)

_(Message COC002)_
@willkg
Copy link
Collaborator

willkg commented Mar 27, 2019

We've already got one: https://github.com/mozilla-services/socorro/blob/master/CODE_OF_CONDUCT.rst

Thank you!

@willkg willkg closed this Mar 27, 2019
@Mozilla-GitHub-Standards
Copy link
Contributor Author

@willkg
Copy link
Collaborator

willkg commented Mar 27, 2019

That's kind of frustrating and unfortunate.

@hwine
Copy link

hwine commented Mar 29, 2019

@willkg - actually, I take it back. You'll need to change. The .rst format is not supported by the GitHub workflow around CoC documents. They don't register in the "Insights Community" display.

@willkg
Copy link
Collaborator

willkg commented Mar 29, 2019

That surprises me since GitHub supports non-.md formats for other files also in that list and there are lots of other projects on GitHub that have .rst files.

If projects are using .rst and Sphinx for documentation, it's easy to include .rst files elsewhere in the repository using the .. INCLUDE:: directive. Then it gets parsed and included in the docs. That's much harder when the file is .md. I really think we should be including these files in our docs. It's not sufficient to have them buried in the repo.

I'll look into it and if it turns out they really don't support CODE_OF_CONDUCT.rst, I'll contact GitHub and ask for support.

@willkg
Copy link
Collaborator

willkg commented Mar 29, 2019

So, it looks like it doesn't have to do with the .rst format but rather that the file is not one of the ones GitHub recognizes.

django-badger has the CODE_OF_CONDUCT.md file, but it's also listed as not having one in the insights page:

Here's the most recent thing I found about that:

https://github.community/t5/How-to-use-Git-and-GitHub/Code-of-Conduct-is-present-in-repo-but-Insights-gt-Community-tab/m-p/15496?advanced=false&collapse_discussion=true&q=CODE_OF_CONDUCT.rst&search_type=thread

If showing up in the insights tab is important, maybe we should use one of the ones they support? Maybe we should contact them and get ours added?

@hwine
Copy link

hwine commented Mar 29, 2019

@willkg that discussion should happen with mozilla-github-standards@m.c -- those folks would be the ones to take any such action or change policy.

@emmairwin
Copy link

So, it looks like it doesn't have to do with the .rst format but rather that the file is not one of the ones GitHub recognizes.

Right.

And to make maintenance sustainable in future.

@g-k
Copy link
Contributor

g-k commented Mar 29, 2019

@willkg @hwine can you CC me on the thread w/ moz-gh-stds or point me to any public discussions?

My understanding is there are two issues:

  • teach the moz-gh-stds bot to recognize CoC .rst files (and ideally provide a template/suggest updates to existing CoC.rst files; implementation-wise pandoc can probably convert .md to .rst)

  • as @emmairwin points out, work with github to recognize the Mozilla CoC (ideally both .md and .rst formats) and display it on community insights pages (i.e. by replying in the thread @willkg mentioned). @hwine pointed out that this work should go through moz-gh-stds@

The benefit of .rst support is that the CoC can be included in other docs and e.g. published in the contributing section of a repo on https://readthedocs.org/ and not require another doc format for Python projects.

@g-k
Copy link
Contributor

g-k commented Mar 29, 2019

@hwine
Copy link

hwine commented Apr 1, 2019

@g-k fyi, script moved to https://github.com/mozilla/Mozilla-GitHub-Standards/

@willkg
Copy link
Collaborator

willkg commented Apr 2, 2019

Reopening to land this.

@willkg willkg reopened this Apr 2, 2019
@willkg
Copy link
Collaborator

willkg commented Apr 2, 2019

On second thought--I'm going to cherry-pick the commit and start a new branch and PR.

@willkg willkg closed this Apr 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants