Вклад в руководства по открытым проектам

Спасибо за интерес к руководствам по открытым проектам! Мы рады слышать вас и учиться вместе с вами. Ваши опыты помогут другим читателям этих руководств.

Мы подготовили следующие рекомендации, чтобы помочь вам понять, где вы сможете лучше всего помочь:

Содержание

0. Типы вкладов, которые мы ищем
1. Основные правила и ожидания
2. Как сделать вклад
3. Руководство по стилю
4. Настройка среды
5. Комьюнити

Типы вкладов, которые мы ищем

Вы можете непосредственно внести свой вклад в руководства различными способами (в порядке убывания необходимости):

• Устранение редакционных несоответствий или неточностей
• Добавление историй, примеров или анекдотов, которые помогают проиллюстрировать идею
• Изменение языка для большей доступности и дружелюбия
• Перевод руководств на другие языки

Хотите сделать вклад? Продолжайте чтение!

Основные правила и ожидания

Прежде чем начнем, вот несколько вещей, которые мы ожидаем от вас (и что вы должны ожидать от других):* Будьте доброжелательными и внимательными в своих беседах вокруг этого проекта. Все мы приходим из разных контекстов и проектов, что значит, у нас могут быть различные взгляды на то, как работает открытый софт. Попробуйте слушать других вместо того, чтобы пытаться убедить их в правильности вашего подхода.

• Руководства по открытым проектам выпускаются с Кодексом поведения участников. Участвуя в этом проекте, вы соглашаетесь соблюдать его условия.
• Если вы открываете запрос на слияние (pull request), убедитесь, что ваш вклад проходит все тесты. Если есть провалы тестов, вам потребуется исправить их перед тем, как мы сможем принять ваш вклад.
• При добавлении содержимого, пожалуйста, рассмотрите, является ли это широко ценным. Пожалуйста, не добавляйте ссылки на материалы, созданные вами или вашим работодателем, так как другие сделают это, если они считают это полезным.## Как сделать вклад

Если вы хотите внести вклад, начните поиском через задачи и запросы на слияние, чтобы узнать, не поднимали ли другие аналогичные идеи или вопросы. Если вы не видите свою идею в списке, а также считаете, что она соответствует целям этого руководства, сделайте одно из следующего:

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

Стиль руководства

Если вы пишете содержание, обратитесь к руководству по стилю, чтобы помочь вашему тексту соответствовать остальному содержанию руководства.

Настройка среды

Этот сайт работает на Jekyll. Для запуска его на локальной машине требуется работающая установка Ruby со вспомогательной библиотекой Bundler.

Как только вы это настроите, выполните:

script/bootstrap
script/server

...и откройте http://localhost:4000 в своем веб-браузере.

СообществоОбсуждение открытых исследовательских проектов происходит в разделах Problems и Pull Requests этого репозитория. Любой человек может присоединиться к этим беседам. Также существует электронная рассылка для регулярных обновлений.Где это возможно, не проводите эти беседы в частных каналах, включая прямое обращение к поддерживаемым лицам. Поддержание открытого общения позволяет всем участникам получать пользу и учиться на беседе.