mozilla / repo-templates

A place to get, and to contribute to standards for Mozilla's Github repos

Mozilla Github Repository Templates

This repository houses the default template required for Mozilla Github repositories.

Getting Started

This repository is currently a work in progress, but all files present under 'templates' represent the currently recommended version for these files.

Updates

Please subscribe to this repo, to ensure your templates are up to date.

Contributing

Pleaser refer to CONTRIBUTING.md

repo-templates's Issues

Missing CONTRIBUTING.md

referenced in https://github.com/mozilla/repo-templates#contributing unless the readme is itself a template?

CODE_OF_CONDUCT.md file missing

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 see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

.rst version of code of conduct?

refs discussion in mozilla-services/socorro#4864

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.

https://github.com/mozilla/repo-templates/issues/5#issue-424891432

#5 (comment)

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• Restricting write access to contributors is strongly encouraged. Please make that change (documentation).

These were made as the result of a recent automated defacement of publically writeable wikis.

Unneeded quotes in the CoC template?

The provided template includes the text "please read our 'How to Report' page.". Do we need the quotes round the How to report link? The other link doesn't have quotes round it.

Trailing whitespace and inconsistent heading spacing

The template Code of Conduct includes trailing whitespace on line 3 (guidelines. ) and line 5 (/participation/). ). This is flagged as a linting error by Markdown validators such as markdownlint.

There is an empty line after the heading # Community Participation Guidelines, but not one after ## How to Report.

Line 8 is 207 characters long, and could be broken up to fit better in a 80 character display.

These would normally be nits, but it appears there is a code of conduct validator that looks for an exact match of the text, so we're encouraging sloppy Markdown across the org. Whitespace linting errors were first identified as an issue in PR #5 a month ago.

Missing CODE_OF_CONDUCT.md

Maybe we can symlink the template one to the top-level to avoid having to update it in two places?