Вклад в проект

Мы приветствуем вклад участников!

Пожалуйста, внимательно прочитайте эту страницу, чтобы процесс проверки кода прошёл как можно более гладко и чтобы увеличить вероятность того, что ваш вклад будет объединён.

Сообщения об ошибках

Для сообщений об ошибках или запросов отправьте проблему через форму: https://github.com/donnemartin/system-design-primer/issues.

Запросы на включение изменений (Pull Requests)

Предпочтительный способ внести свой вклад — это разветвить основной репозиторий на GitHub.

1. Разветвите основной репозиторий:

   • Нажмите кнопку «Fork» в верхней части страницы. Это создаст копию кода под вашей учётной записью на сервере GitHub.

2. Скопируйте эту копию на свой локальный диск:

   • $ git clone git@github.com:YourLogin/system-design-primer.git
   • cd system-design-primer

3. Создайте ветку для хранения ваших изменений и начните вносить изменения. Не работайте в ветке master!

   • $ git checkout -b my-feature

4. Работайте над этой копией на своём компьютере, используя Git для контроля версий. Когда вы закончите редактирование, выполните следующие действия, чтобы записать свои изменения в Git:

   • $ git add modified_files
   • $ git commit

5. Отправьте свои изменения на GitHub:

   • $ git push -u origin my-feature

6. Наконец, перейдите на веб-страницу своего форка репозитория system-design-primer и нажмите «Pull Request», чтобы отправить свои изменения для проверки.

Документация по запросам на включение изменений GitHub

Если вы не знакомы с запросами на включение изменений, ознакомьтесь с документацией по ним: https://help.github.com/articles/using-pull-requests/.

Переводы

Мы хотели бы, чтобы руководство было доступно на многих языках. Вот процесс поддержания переводов:

• Оригинальная версия и содержание руководства поддерживаются на английском языке.
• Переводы следуют содержанию оригинала. Участники должны говорить хотя бы немного по-английски, чтобы переводы не расходились.
• У каждого перевода есть сопровождающий, который обновляет перевод по мере развития оригинала и проверяет изменения других. Это не требует много времени, но проверка сопровождающим важна для поддержания качества.

Смотрите раздел «Переводы» (TRANSLATIONS.md).

Изменения в переводах

• Изменения в содержании должны быть внесены сначала в английскую версию, а затем переведены на другие языки.
• Изменения, улучшающие переводы, должны вноситься непосредственно в файл для этого языка. Запросы на включение изменений должны изменять только один язык за раз.
• Отправьте запрос на включение изменений с изменениями в файле на этом языке. У каждого языка есть сопровождающий, который проверяет изменения на этом языке. Затем основной сопровождающий @donnemartin объединяет их.
• Префикс запросов на включение изменений и проблем кодами языков, если они предназначены только для этого перевода, например, «es: Улучшить грамматику», чтобы сопровождающие могли легко их найти.
• Отметьте сопровождающего перевода для проверки кода, см. список сопровождающих переводов (TRANSLATIONS.md). Вам потребуется получить отзыв от носителя языка (предпочтительно сопровождающего языка), прежде чем ваш запрос на включение изменений будет объединён.

Добавление переводов на новые языки

Переводы на новые языки всегда приветствуются! Имейте в виду, что перевод должен поддерживаться.

• Есть ли у вас время стать сопровождающим нового языка? Пожалуйста, посмотрите список переводов (TRANSLATIONS.md) и сообщите нам, чтобы мы знали, что можем рассчитывать на вас в будущем.

• Проверьте переводы (TRANSLATIONS.md), проблемы и запросы на включение изменений, чтобы узнать, ведётся ли перевод или приостановлен. Если он ведётся, предложите помощь. Если он приостановлен, рассмотрите возможность стать сопровождающим, если сможете взять на себя обязательства.

• Если перевод ещё не начат, создайте проблему для вашего языка, чтобы люди знали, что вы работаете над ним, и мы скоординируем действия. Подтвердите, что вы владеете языком на уровне носителя и готовы поддерживать перевод, чтобы он не остался без сопровождения.

• Чтобы начать, разветвите репозиторий, затем отправьте запрос на включение изменений в основной репозиторий с добавленным единственным файлом README-xx.md, где xx — код языка. Используйте стандартные коды языков IETF. Перевод текста:

• Используйте языковые теги, как это делает Википедия, а не код для отдельной страны. Обычно это двухбуквенный код в нижнем регистре, например, fr для французского и uk для украинского (не ua, который используется для страны). Для языков, имеющих вариации, используйте самый короткий тег, такой как zh-Hant.

• Не стесняйтесь приглашать друзей, чтобы помочь с переводом, попросив их создать форк вашего репозитория, а затем объединив их пул реквесты в свой форкнутый репозиторий. Переводы сложны и обычно содержат ошибки, которые должны найти другие.

• Добавляйте ссылки на свой перевод в начало каждого файла README-XX.md. Для единообразия ссылка должна быть добавлена в алфавитном порядке по коду ISO, а текст привязки должен быть на родном языке.

• Когда вы полностью переведёте английский файл README.md, прокомментируйте запрос на вытягивание в основном репозитории, что он готов к объединению.

  • Вам потребуется иметь полный и проверенный перевод английского файла README.md, прежде чем ваш перевод будет объединён в ветку master.
  • После принятия ваш запрос на вытягивание будет сжат в один коммит в ветке master.

Автор шаблона перевода

Спасибо проекту «The Art of Command Line» за шаблон перевода.