Skip to content

Commit e251dfd

Browse files
authored
Update CONTRIBUTING.md подчистил формулировки
1 parent 98fc8e9 commit e251dfd

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
## Оформление
44

5-
- Символ отступа — пробел. Табуляция в файлах с расширением`.xml` спровоцирует ошибку.
5+
- Символ отступа — пробел; табуляция в файлах с расширением`.xml` спровоцирует ошибку. В XML-документах пробелы в конце строк тоже вызовут ошибку.
66
- В документации пишут букву `ё`, чтобы исключить риск двойного прочтения.
7+
- При оформлении текстов соблюдают правила типографики: пишут тире, кавычки-ёлочки, сокращения в конструкциях наподобие `т. п.` или `т. д.` разделяют пробелом, соблюдают правила наращения числительных и т. д.
78

89
## Рекомендации по переводу
910

10-
Комментарии к коду требуется переводить;
11-
описание вывода наподобие `echo "You reload page $num times";` — тоже переводится.
11+
Комментарии к примерам кода переводят на русский язык;
12+
описание вывода наподобие `echo "You reload page $num times";` — тоже переводится. Текст ошибок и исключений не переводится.
1213

1314
Исключение: английские слова в коде не переводятся, если перевод на русский язык изменит поведение функции, например,
1415
`strtolower("Alex") === "alex"`, но `strtolower("Алексей") !== "алексей"`.
@@ -22,8 +23,8 @@
2223
который описывает рекомендация [PER](https://www.php-fig.org/per/coding-style/),
2324
даже если потребуется изменить форматирование примера оригинальной документации.
2425

25-
Оригинальный текст переводят предельно точно, отступления допускаются только для сохранения семантики, если буквальный перевод исказит смысл.
26-
При неточных или ошибочных формулировках в исходной документации вначале через запрос на слияние исправляют английскую версию, а только потом обновляют русскую.
26+
Оригинальный текст переводят _предельно точно,_ отступления допускаются только для сохранения семантики, если буквальный перевод исказит смысл.
27+
При неточных или ошибочных формулировках в исходной документации вначале исправляют английскую версию путём отправки запроса на слияние, а только потом обновляют русскую.
2728

2829
## Актуализация перевода
2930

@@ -245,43 +246,41 @@ php phd/render.php --docbook doc-base/.manual.xml --package PHP --format xhtml
245246
| PHP_VERSION | Константа PHP_VERSION |
246247
| `var_dump()` | Функция `var_dump()` |
247248

248-
Одного уточнения хватит, если в предложении или коротком абзаце термин встречается больше одного раза, по смыслу.
249+
Одного уточнения достаточно, если в предложении или коротком абзаце термин встречается больше одного раза, по смыслу.
249250
При добавлении уточняющего слова дайте точное определение. Для термина `$_SERVER` доступны
250251
уточнения: «Переменная $_SERVER», «Глобальная переменная $_SERVER» или «Суперглобальная переменная $_SERVER» — лучше предпочесть последнее.
251252

252253
## Параметры и аргументы
253254

254-
Параметр — член функции, который принадлежит функции, составляет сигнатуру функции или метода.
255+
Параметр — неотъемлемая часть сигнатуры функции или метода.
255256
Аргумент — значение, которое передают в функцию или метод «снаружи», чтобы определить значение параметра.
256-
Аргумент допускается передавать в функцию, передать в функцию параметр — нельзя, поскольку он уже находится «внутри» функции.
257+
Аргумент допускается передавать в функцию, передать параметр — невозможно, поскольку параметр — «внутренняя часть» функции.
257258

258-
Участники перевода руководствуются этими разъяснениями, даже если в оригинальной документации «параметры»
259+
Участники перевода руководствуются логикой передачи аргументов и приёма аргументов параметрами функции, даже если в оригинальной документации «параметры»
259260
и «аргументы» употребили некорректно.
260261

261262
## Скобки
262263

263-
Скобки затрудняют и замедляют чтение. Читатель «спотыкается» о скобки. Но без скобок нельзя обойтись. «В скобки заключают
264-
слова и предложения, вставляемые в предложение с целью пояснения или дополнения высказываемой мысли, а также
265-
для каких-либо добавочных замечаний» — гласят правила русского языка.
264+
Пояснения или добавочные замечания в предложении стараются не обрамлять скобками; скобки затрудняют и замедляют чтение, заставляют читателя «спотыкаться». Лучше вынести высказывание за скобки или в отдельное предложение.
266265

267-
При переводе <em>не нужно</em> брать в скобки названия параметров.
266+
При переводе названия параметров _не берут_ в скобки.
268267

269268
Например:
270269

271270
> Функция больше не поддерживает передачу разделителя `<parameter>separator</parameter>` после массива `<parameter>array</parameter>`.
272271
273272
В примере названия параметров — полноценные и равноправные члены предложения.
274273

275-
Названия типов <em>нужно</em> брать в скобки.
274+
При этом названия типов _обрамляют_ скобками.
276275

277276
Например:
278277

279278
> Функция возвращает строку (`<type>string</type>`).
280279
281-
В этом примере слово string (вместе с тегами) взяли в скобки, потому что слово поясняет,
280+
В примере слово `string` вместе с тегами взяли в скобки, потому что слово поясняет,
282281
что «строка», кроме словарного значения, означает тип данных.
283282

284-
Старайтесь избавиться от скобок, если уместно (если это не часть примера или выражения и т. д.),
283+
Старайтесь избавляться от скобок, если уместно и если скобки — не часть примера или выражения,
285284
даже если в исходной документации слова или предложения указали в скобках.
286285

287286
Точку ставят после закрывающей скобки, если слова в скобках — часть предложения (как в этом примере).

0 commit comments

Comments
 (0)