Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion contributing-guides/style-guide.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,13 +307,24 @@ tldr --render путь/к/tldr_page.md

Избегайте объяснения общих концепций UNIX, которые могут применяться к любой команде (т.е. относительные/абсолютные пути, glob-шаблоны/wildcards, экранирование спецсимволов, возвращаемые значения программ и т.д.).

При описании переменной окружения для платформ UNIX добавляйте знак доллара перед переменной и заключайте её в обратные кавычки (`$VARIABLE_NAME`). Например: "Управление переменной окружения `$JAVA_HOME`".

Для командной строки Windows добавляйте знак процента в начало и в конец переменной и заключайте её в обратные кавычки (`%VARIABLE_NAME%`). Например: "Управление переменной окружения `%JAVA_HOME%`".

Для PowerShell добавляйте перед переменной знак доллара, Env и двоеточие, затем заключайте её в обратные кавычки (`$Env:VARIABLE_NAME`). Например: "Управление переменной окружения `$Env:JAVA_HOME`".

При описании форматов файлов используйте преимущественно их названия обычным текстом (например, JSON, SQLite) или расширение файла с точкой в начале, заключенное в обратные кавычки (например, `.txt`).

### Стандартизированные термины

Некоторые термины используются многократно на разных страницах и, следовательно, должны быть стандартизированы. К ним относятся:

| Термин | Стандарт | Объяснение |
| --- | --- | --- |
| Регулярное выражение | `` `regex` `` | `regex` определяет шаблон для поиска в строке символов (https://en.wikipedia.org/wiki/Regular_expression). |
| Стандартный ввод | `` `stdin` `` | |
| Стандартный вывод | `` `stdout` `` | |
| Стандартный поток ошибок | `` `stderr` `` | |

## Заголовок

Expand Down Expand Up @@ -343,7 +354,7 @@ tldr --render путь/к/tldr_page.md
- Для `osx`: Apple распространяет встроенные man-страницы [в Xcode](https://developer.apple.com/documentation/os/reading_unix_manual_pages). Для команд, документированных там, мы рекомендуем использовать <https://keith.github.io/xcode-man-pages/>, HTML-экспорт всех man-страниц Apple, поставляемых с Xcode.

> [!IMPORTANT]\
> Все ссылки должны быть заключены в угловые скобки (`<` и `>`).
> Все ссылки должны быть заключены в угловые скобки (`<` и `>`) для корректного отображения в клиентах.

- Рекомендуется использовать ссылку "Больше информации" с англоязычным контентом как в переводах, так и на английских страницах. Это связано с тем, что ссылки со временем могут меняться, а переводы часто отстают от английских страниц.

Expand Down
Loading