Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 6.38 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 6.38 KB
Raw

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

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

Указать на баг или неточность

Перед тем как сообщить о какой-либо ошибке, проверьте, не сообщили ли о ней ранее в issue-трекере.

Взяться за выполнение задачи

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

Задачи, соотвествующие текущему этапу разработки, находятся в данном разделе, а на данной доске вы можете увидеть все наиболее актуальные задачи, включая соответствующие текущему этапу и не зависящие от него. Если вы решили взять задачу, которая есть на доске и находится в статусе "Ready", отличным решением будет переместить её в статус "Doing", а по завершении - в статус "Done". Это упростит разработку и вам, и другим разработчикам.

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

В качестве подготовки к проекту рекомендуем ознакомится с материалами по ссылке.

Разработка

  1. Если у вас нет SSH-ключей, сгенерируйте их и подключите к гитхабу, чтобы работать с репозиторием по SSH: https://help.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account

  2. Ознакомьтесь с принципами разработки принятыми в этом проекте.

  3. Сделайте fork проекта (кнопка fork в правом верхнем углу на странице https://github.com/hexlet-codebattle/codebattle) и клонируйте репозиторий:

    git clone git@github.com:%your-username%/codebattle.git

  4. Следуйте инструкциям по установке.

  5. Перед тем как начать писать код, необходимо создать ветку для разработки из ветки master. Важно учитывать, что в одной ветке может находиться решение только одной задачи!

    git checkout master
git checkout -b %your_branch_name%

  6. После выполнения задачи коммитите изменения (текст коммита на английском) и отправляете в удаленный репозиторий.

    git add . && git commit -m "%useful_commit_message%"
git push --set-upstream origin %your_branch_name%

  7. Создайте pull request.

Создание pull request

Чтобы создать PR, необходимо:

  • Убедиться, что все тесты выполняются успешно и линтер не выдает ошибок
  • Зайти на основной репозиторий
  • Скорее всего гитхаб сам предложит вам создать PR, тем не менее, стоит заглянуть сюда
  • Не забываем в комментарии к PR ссылаться на issue

После завершения работы над задачей не забудьте синхронизировать ваш fork с основным репозиторием.

    git remote add upstream git@github.com:hexlet-codebattle/codebattle.git
    git fetch upstream
    git checkout master
    git merge upstream/master

Подробные инструкции по работе с PR

Спасибо за помощь !