Если ты открываешь эту страницу, значит, тебе захотелось чем-то помочь нашему проекту. Ниже ты увидишь полезную информацию для того, чтобы понять, как именно это делать. Удачи!
Если ты уже разбираешься в Git, ниже лишь гайд для новичков. Важно лишь то, что мы пользуемся Conventional Commits. Удачи!
Для начала - прочитай README, чтобы понять, на что нацелен наш проект. Ниже есть несколько ссылок, по которым можно узнать, как работать с Open Source:
- Тренажёр Git
- Основы работы с Github (пропусти секцию с SSH)
Сначала надо решить, что ты будешь делать.
Issue - это способ сообщить об ошибке или задать вопрос разработчикам. Перед тем, как задавать какой-либо вопрос, проверь, не задал ли его кто-то ещё!
Если твой вопрос/ошибка не является дубликатом другой issue - смело открывай новую. Постарайся в деталях рассказать, что у тебя за вопрос/ошибка. Если это ошибка - приведи как можно больше информации о твоём рабочем окружении, о приложении, о версии и т.д. Если открыл issue - старайся иногда проверять её, возможно, тебя попросят отправить дополнительную информацию. Если сам нашёл решение - не стесняйся! Напиши его в issue и закрой её, как решённую.
Pull request (иногда используется название pull-запрос) - запрос, который сообщает разработчикам, что ты сделал изменения в код и хочешь, чтобы эти изменения попали в код. Pull request даёт тебе немало возможностей, но важна и ответственность.
Коммит - это способ сохранения изменений в коде.
- Скачай любой GUI-клиент для Git, например, Github Desktop. Вот тут можешь узнать о том, как пользоваться этой программой.
- Далее тебе понадобится форкнуть репозиторий.
- Открой свой любимый редактор кода, например, VS Code, внеси те изменения, которые тебе хотелось сделать.
- Сохрани изменения в редакторе кода.
- Зайди в Github Desktop, он предложит тебе сделать коммит.
- Заголовок коммита сделай по шаблону.
Перед созданием проверь, всё ли работает правильно? Следуй этому гайду, чтобы сделать Pull request. Если вдруг ты увидишь, что сделал не всё - не расстраивайся! Напиши об этом на странице Pull request'а и просто доделай всё, что тебе нужно! Если понимаешь, что на окончание работы нужно больше времени - также сообщи об этом.
Поздравляем! Твои изменения уже скоро появятся в коде, а позже - и в новом обновлении. Спасибо за твой вклад!