GitHub/Repository Requirements: Difference between revisions
< GitHub
(point to upstream repo as example) |
(Fix URL for "raw template file" (previously a 404)) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Hosting a repository in | Hosting a repository in a Mozilla organization, or a Mozilla community organization on GitHub requires compliance with a few guidelines. | ||
== Code Of Conduct == | == Code Of Conduct == | ||
As of January 1 2019, Mozilla requires that all | As of January 1 2019, Mozilla requires that all GitHub projects include this [https://github.com/mozilla/repo-templates/blob/master/templates/CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md] file in the project root. The file has two parts: | ||
# '''Required Text''' - All text under the headings ''Community Participation Guidelines and How to Report'', are required, and should not be altered. | # '''Required Text''' - All text under the headings ''Community Participation Guidelines and How to Report'', are required, and should not be altered. | ||
# '''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 [https://github.com/devtools-html/debugger.html/blob/master/CODE_OF_CONDUCT.md Firefox Debugger] project, and [https://github.com/mozilla/voice-web/blob/master/CODE_OF_CONDUCT.md Common Voice]. (The optional part is commented out in the [https:// | # '''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 [https://github.com/devtools-html/debugger.html/blob/master/CODE_OF_CONDUCT.md Firefox Debugger] project, and [https://github.com/mozilla/voice-web/blob/master/CODE_OF_CONDUCT.md Common Voice]. (The optional part is commented out in the [https://raw.githubusercontent.com/mozilla/repo-templates/master/templates/CODE_OF_CONDUCT.md 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 the Mozilla-GitHub-Standards team ({{emailentry|Mozilla-GitHub-Standards|mozilla.com|at=is}}). | |||
=== Implementation Notes === | |||
* The current requirements can be met by simply adding a file to the repository. | |||
* If you're trying to bring an entire organization into compliance, a "bot" will open a PR for you. That bot is [https://github.com/Mozilla-GitHub-Standards Mozilla-GitHub-Standards] ''(source is in [https://github.com/mozilla/Mozilla-GitHub-Standards this repository])''. Feel free to fork and run! (i.e. it's not supported or maintained.) | |||
* For Python projects, Will Kahn-Greene wrote a nice [https://bluesock.org/~willkg/blog/mozilla/code_of_conduct.html recommendation]. Thanks, Will! | |||
Latest revision as of 13:35, 6 March 2023
Hosting a repository in a Mozilla organization, or a Mozilla community organization on GitHub requires compliance with a few guidelines.
Code Of Conduct
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:
- Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
- 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 the Mozilla-GitHub-Standards team (Mozilla-GitHub-Standards 
mozilla.com).
Implementation Notes
- The current requirements can be met by simply adding a file to the repository.
- If you're trying to bring an entire organization into compliance, a "bot" will open a PR for you. That bot is Mozilla-GitHub-Standards (source is in this repository). Feel free to fork and run! (i.e. it's not supported or maintained.)
- For Python projects, Will Kahn-Greene wrote a nice recommendation. Thanks, Will!