tldr/CONTRIBUTING.md

Contributing

Contributions to the tldr-pages project are most welcome! All tldr pages are stored in Markdown right here on GitHub. Just open an issue or send a pull request and we'll incorporate it as soon as possible. To get started, please sign the Contributor License Agreement.

Note: when submitting a new command, don't forget to check if there's already a pull request in progress for it.

Guidelines

The basic format of a tldr page is a set of concrete usage examples. Here are a few guidelines to get started:

1. Try to keep pages at around 5 examples. Pages can be longer if needed, but don't exceed 8 examples. Remember, it's OK if the page doesn't cover everything; that's what man is for.
2. When in doubt, keep new command-line users in mind. Err on the side of clarity rather than terseness. For example, commands that require sudo should include it directly in the examples.
3. Try to incorporate the spelled-out version of single-letter options in the example's description. The goal is to allow people to understand the syntax of the commands, not just memorize it.
4. Introduce options gradually, starting with the simplest command invocations, and using more complex examples progressively.
5. Focus on details specific to the command, and avoid explaining general UNIX concepts that could apply to any command (ex: relative/absolute paths, glob patterns/wildcards, special character escaping...).

These are all guidelines, not strict rules. Use proper judgement, keeping simplicity and user-friendliness as the top priority.

When in doubt, have a look at a few existing pages :).

Markdown format

As a quick reference, the format of each page should match the following template:

# command-name

> Short, snappy description.
> Preferably one line; two are acceptable if necessary.

- Example description:

`command -opt1 -opt2 -arg1 {{arg_value}}`

- Example description:

`command -opt1 -opt2`

For more detailed page formatting guidelines, refer to the style guide.

Translations

Translation of pages can be done by simply creating the corresponding page within the appropriate language-specific directory, creating that as well if it does not already exist.

Language specific directories must follow the pattern pages.<language_tag>, where <language_tag> is a BCP 47 conforming tag in the form of <language>[-<region>], where:

• <language> is the shortest ISO 639 language code for the chosen language (see here for a complete list).
• <region> is the two-letter ISO 3166-1 region code for the chosen region (see here for a complete list).

The <region> code is optional and should only be added when it is needed to distinguish between an already existing <language> and one of its regional dialects. As an example, both fr-FR and fr-BE should fall under the same pages.fr directory, since there virtually is no difference in writing between standard French and Belgian French.

Some examples of valid BCP 47 tags:

• French: fr.
• Chinese: zh.
• Chinese (Singapore): zh-SG.
• Portuguese (Brazil): pt-BR.

You can check the validity of BCP 47 tags here.

Default language for newly added pages

The default language used for pages is English (US). Pages written in English are stored in the default pages directory (notice the absence of a specific language tag). Although not strictly required, if you'd like to add a new page in a different language, please consider creating the English page too.

Submitting a pull request

The easiest way to submit a change is to just edit the page directly on the Github interface. Check out the step-by-step instructions (with screenshots) on Github Help.

Alternatively, you can do most of the process using git on the command line.

Commit message

For the commit message, use the following format:

<command>: type of change

Examples:

• For a new page addition: ls: add page
• For a page edit: cat: fix typo, git-push: add --force example
• For a new translation of an existing page: cp: add Tamil translation
• For related changes to several pages: grep, find, locate: synchronize format of wildcards

Licensing

tldr is licensed under the MIT license.

Any contributions to this project are governed by the Contributor License Agreement.