Внесение вклада в проект

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

Создание проблемы

Если вы обнаружили ошибку в проекте, который используете (и не знаете, как её исправить), испытываете трудности с пониманием документации или у вас есть вопрос о проекте – создайте проблему! Это очень просто, и независимо от проблемы, с которой вы столкнулись, вы, вероятно, не одиноки, поэтому другие найдут вашу проблему полезной. Для получения дополнительной информации о том, как работают проблемы, ознакомьтесь с нашим руководством по проблемам.

Советы по созданию проблем

Проверьте существующие проблемы на наличие вашей проблемы. Дублирование проблемы замедляет обе стороны, поэтому просмотрите открытые и закрытые проблемы, чтобы убедиться, что ваша проблема уже была решена. Будьте ясны в описании вашей проблемы: каков был ожидаемый результат, что произошло вместо этого? Укажите, как другой человек может воспроизвести проблему. Ссылайтесь на демонстрации воспроизведения проблемы на сайтах, таких как JSFiddle или CodePen. Укажите детали системы, такие как браузер, библиотека или операционная система, которую вы используете, и её версию. Вставьте вывод ошибки или журналы в вашу проблему или в Gist. Если вы вставляете их в проблему, оберните их в три обратные кавычки: ``` для того, чтобы они отображались правильно.### Пулл-запрос

Если вы можете исправить ошибку или добавить функцию самостоятельно — замечательно, создайте пулл-запрос с кодом! Убедитесь, что вы ознакомились с любыми документами по внесению вклада, понимаете лицензию и подписали CLA, если это требуется. После того, как вы отправите пулл-запрос, поддерживаемые лица смогут сравнить ваш ветвь с существующей и решить, включать ли ваши изменения.#### Советы по созданию пулл-запросов

Создайте вилку репозитория и клонируйте его локально. Соедините ваш локальный репозиторий с исходным репозиторием «upstream» путем добавления его как удаленного репозитория. Часто получайте изменения из «upstream», чтобы оставаться в курсе обновлений, что уменьшит вероятность возникновения конфликтов слияния при отправке запроса на слияние. Подробные инструкции можно найти здесь.

Создайте ветку для ваших изменений. Укажите ясно, какая проблема возникает, и как ее можно воспроизвести, или почему ваша функция будет полезна. Затем укажите также подробно шаги, которые вы предприняли для внесения изменений.

Лучше всего провести тестирование. Запустите ваши изменения против существующих тестов, если они есть, и создайте новые тесты, когда это необходимо. Независимо от того, существуют ли тесты или нет, убедитесь, что ваши изменения не нарушат существующий проект.

Добавьте скриншоты до и после, если ваши изменения включают различия в HTML/CSS. Перетащите и опустите изображения в тело вашего запроса на слияние.

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

Открытые pull request'ыКак только вы откроете pull request, начнется обсуждение ваших предложенных изменений. Другие участники и пользователи могут присоединиться к обсуждению, но в конечном итоге решение принимается поддерживателем(ями). Вас могут попросить внести некоторые изменения в ваш pull request. Если это так, добавьте новые коммиты в ваш ветвь и отправьте их — они автоматически будут добавлены в существующий pull request.

Если ваш pull request был принят — отлично! Если нет, это не страшно, возможно, это не то, что поддерживатель проекта имел в виду, или он уже работал над этим. Такое случается, поэтому наш совет — используйте любую полученную обратную связь и продолжайте отправлять pull request'ы — или создайте свой собственный проект с открытым исходным кодом.