com doc/ru: Добавлен ие инструкц ии по актуа лизации пер евода: CONTRIBUTING.md

Commit: 9a7db17bcc7e1618e3179f2de030f38f64f8337c Author: Sergey Panteleev <sergey@php.net> Fri, 19 Mar 2021 09:22:48 +0300 Parents: 66a8720ff7018b4480751a11539c0175aeafc4b4 Branches: master Link: http://git.php.net/?p=doc/ru.git;a=commitdiff;h=9a7db17bcc7e1618e3179f2de030f38f64f8337c Log: Добавление инструкции по актуализации перевода Closes GH-29 Changed paths: M CONTRIBUTING.md Diff: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a96420e7..dc11b0cc2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,26 @@ Заголовок <title><function>func_name</function> example</title> всегда переводится как <title>Пример использования <function>func_name</function></title>. +## Актуализация перевода + +Оригинал англоязычной документации находится по адресу [doc/en](https://github.com/php/doc-en). + +Файлы русскоязычной документации имеют определённый формат. В начале каждого файла должна быть конструкция следующего вида: + +```xml +<?xml version="1.0" encoding="utf-8"?> +<!-- EN-Revision: 0abaad099e3ec6064ed8cf31553dcd5e3e3fdfba Maintainer: sergey Status: ready --> +<!-- Reviewed: yes --> +<!-- $Revision$ --> +``` + +где 0abaad099e3ec6064ed8cf31553dcd5e3e3fdfba — полный номер коммита в англоязычной документации, последнего актуального на момент редактирования для данного файла. +Это нужно для того, чтобы понимать, что именно переведено, а что ещё нет. + +[Инструмент для отслеживания изменений](https://doc.php.gpb.moe/tools/revcheck/ru/outdated.html) отображает устаревшие файлы, а также все изменения. + +Для актуализации перевода необходимо выбрать файл, посмотреть различия (filename.xml [diff]), внести изменения, обновить тег EN-Revision на значение из столбца en и прислать пуллреквест. + ## Соглашение по переводу | Оригинал | Перевод |