- Для начала, вам нужно сделать Fork текущего репозитория с переводом
- В своем репозитории перевода создайте branch и внесите законченный набор изменений в перевод. Желательно, чтобы изменения касались не более чем 10 файлов на один
Pull Request
- Актуальную версию английской документации берите из репозитория symfony-docs
- Когда вы закончили правки в переводе, из нужного
branch
сделайте Pull Request - Для бОльшего удобства при определении изменений в файле перевода необходимо:
5.1. При создании нового перевода добавить в конец файла такую конструкцию (не будет отображаться при генерации):
Translation source: YYYY-mm-dd REV
- где
YYYY-mm-dd дата когда был взят исходник перевода, REV - короткий хеш ревизии (можно посмотреть командой git log --oneline [file])
5.2. При обновлении перевода добавить в историю правок строку
Corrected from: YYYY-mm-dd REV
- где
YYYY-mm-dd - дата когда был взят исходник для коррекции REV - также хеш ревизии по которой делалась коррекция
- Некоторые частные случаи:
Исходный вариант | Правильный перевод | Неправильный перевод |
Response object | объект Response | объект ответа |
Служебная разметка:
- :orphan: - .. glossary:: - .. note:: - .. tip:: - .. toctree:: :maxdepth: 2 :glob: :numbered:
- Служебные слова: "
API
", "HTTP
", "Symfony2
", "Controller
", "Response
", etc.
* Правила форматирования документации: Symfony2 Documentation Format и reStructuredText Markup Specification