kevin/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr synced 2026-08-26 14:13:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING: adjust wording to avoid misunderstandings. (#23259)

Browse Source
This commit is contained in:
Managor
2026-07-20 11:59:18 +07:00
committed by GitHub
parent 0153942fec
commit 8081da0710
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -4
View File
@@ -102,7 +102,7 @@ As a quick reference, the format of each page should match the following templat
# command-name
> Short, snappy description.
> Preferably one line; two are acceptable if necessary.
> Further clarification of the functionality only when absolutely necessary.
> More information: <https://url-to-upstream.tld>.
- Example description:
@@ -117,12 +117,12 @@ As a quick reference, the format of each page should match the following templat
For page descriptions, you can additionally use ``See also: `command`.`` and [subcommand reference](#subcommands).
> [!NOTE]
> While we suggest only two lines for the page description, it is acceptable to have more than two lines if it is necessary to add additional information (i.e. [`pacman`](https://github.com/tldr-pages/tldr/blob/main/pages/linux/pacman.md)).
> While we suggest only two lines for the page description, it is acceptable to have more than two lines if it is necessary to add additional information (i.e. [`pacman`](https://github.com/tldr-pages/tldr/blob/main/pages/linux/pacman.md?plain=1)).
To see some examples of preexisting pages, you can look at:
- [pwd](https://github.com/tldr-pages/tldr/blob/main/pages/common/pwd.md) - one of the simplest command examples
- [tar](https://github.com/tldr-pages/tldr/blob/main/pages/common/tar.md) - page with placeholders
- [pwd](https://github.com/tldr-pages/tldr/blob/main/pages/common/pwd.md?plain=1) - one of the simplest command examples
- [tar](https://github.com/tldr-pages/tldr/blob/main/pages/common/tar.md?plain=1) - page with placeholders
In our pages, we use placeholders defined as being tokens within curly brackets. For example, in `sleep {{5}}`, the user can change 5 to any number.