Первая правка в чужой проект: пошагово

Шаг 1. Выберите задачу

Найдите проект, которым пользуетесь, и посмотрите список открытых задач. Ищите пометки вроде «для новичков» или «простая». Если таких нет — начните с документации: неточность, устаревший пример, отсутствующее пояснение.

Прежде чем браться, напишите в задаче, что берётесь. Это правило вежливости и заодно страховка от того, что то же самое делает кто-то ещё.

Шаг 2. Прочитайте правила

В корне проекта почти всегда лежит файл с правилами участия. Там написано, как оформлять изменения, как называть ветки и что должно быть в описании. Половина отклонённых правок — от тех, кто этот файл не открыл.

Шаг 3. Сделайте копию и ветку

Нажмите «сделать копию» на странице проекта, склонируйте её к себе и создайте отдельную ветку под задачу:

git clone <ваша копия>
cd <проект>
git checkout -b fix-docs-typo

Название ветки — короткое и по делу. Работать в главной ветке не надо.

Шаг 4. Внесите изменение

Одно изменение — одна задача. Не поддавайтесь искушению заодно поправить отступы во всём файле: такие правки сложно проверять, и их часто отклоняют целиком.

Проверьте, что проект собирается и тесты проходят. Как их запускать, обычно написано в тех же правилах.

Шаг 5. Оформите коммит

git add .
git commit -m "docs: поправил пример запуска в README"

Сообщение должно объяснять, что сделано. «fix» или «update» ни о чём не говорят.

Шаг 6. Отправьте и создайте запрос

git push origin fix-docs-typo

Дальше на странице проекта появится предложение создать запрос на слияние. В описании напишите: что было не так, что вы изменили, как это проверить. Если правка связана с задачей — сошлитесь на неё.

Шаг 7. Ответьте на замечания

Почти наверняка попросят что-то поправить. Это не отказ, а обычная часть процесса.

Правьте в той же ветке — запрос обновится сам. На каждое замечание отвечайте: исправил или объясните, почему сделали иначе.

Шаг 8. Изменение приняли

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

Если не приняли

Бывает. Проект мог изменить планы, поддерживающий — не согласиться с подходом. Спросите, что можно было сделать иначе, и попробуйте в другом месте. Опыт всё равно остался при вас.