Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 2.48 KB

README.md

File metadata and controls

23 lines (14 loc) · 2.48 KB
Raw

Guidelines for creating community style guides

This document provides step-by-step instructions for creating a community style guide. Community style guides are to be used in coordination with the Mozilla general localization style guide but provide additional information that is vital to producing a high-quality translation in the community locale.

For creating new style guides, we have prepared a template you can use. Each heading in the template represents a common style topic in localization. Each topic features one or more questions that pertain to the information of the topic. Below each question is a description of how to answer the question and some examples of relevant information.

Note: All style guides use Markdown, which you may know from GitHub already. If not, Mastering Markdown or Basic writing and formatting syntax will give you a good introduction.

How to use these guidelines

  1. Create a folder for your locale in the /docs folder.
  2. Copy the file with the style guide template to your locale folder.
  3. Fill out each section of the template, using the questions and directions from the guidelines below. Refer to the example style guide as necessary.
  4. Submit a pull request to the repository administrators.
  5. Request a review of your style guide from another member of your community (if there are no other members of your community, include a note in your pull request).

If your community already has a style guide, you can follow these steps, using your style guide as a resource for relevant information, or you can use these guidelines to review and update your style guide.

The language you use in your style guide is up to your community. It is recommended that you use your language or English (or your source language if you don’t translate from English).

As you follow these steps, only include information that is relevant to your locale. If you are using the style guide template, remove sections of the template that do not apply to your language or locale and remove the included template comments as you complete sections.

Once you have updated or create your community style guide, submit a pull request to the repository managers.