Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 4.74 KB

Участие в проекте

Спасибо за интерес к нашему проекту. Есть много способов помочь, и все виды помощи ценны для нас.

Расскажите о нас

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

Опечатки и стиль

Следующий простой способ помочь - исправлять опечатки, которые вы встречаете по мере чтения. Усилия, которые вы затратите на исправление опечатки, примерно равны усилиям на создание задачи об опечатке - и при этом снимают с нас часть работы.

Это проще, чем кажется - любой файл в репозитории можно редактировать прямо в браузере. При этом GitHub сам создаст ветку и сделает Pull Request. Просто кликните по файлу в списке в веб-интерфейсе GitHub, а затем нажмите на маленькую иконку карандаша.

Отредактируйте файл, введите сообщение коммита - и готово. Pull Request создан и мы уведомлены о нём.

Уже созданные задачи на исправление опечаток имеют соответствующую метку в репозитории.

Корявые фразы, калька с английского, непонятные места подлежат исправлению тем же способом. У них также есть метка.

Перевод

Вы можете поучаствовать в переводе ещё не переведённых частей или помочь привести перевод в соответствие с оригиналом.

Для этого смотрите задачи с меткой "тип: содержимое".

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

Инфраструктура

Есть определённые инфраструктурные задачи. Они, как правило, требуют программирования - или, по крайней мере, редактирования каких-то конфигурационных файлов и скриптов.

Это задачи с меткой "тип: инфраструктура".

Pull Request'ы

При создании и рецензировании Pull Request'ов следует придерживаться трёх правил:

  1. Понятно описывайте свою работу. Это значит, что сообщения коммитов и Pull Request'а должны быть в правильном формате и на русском языке.
  2. Адекватно реагируйте на замечания в процессе рецензирования. Рецензирование - способ поддержания качества нашего проекта.
  3. Не забивайте на обновление PR по результатам рецензирования. Вы лучше всего разбираетесь в том, что вы сделали, и кроме вас никто не займётся вливанием ваших правок в проект.

Подробнее о процессе и правилах читайте здесь.