shad-go/CONTRIBUTING.md
2023-10-03 20:25:41 +03:00

45 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Как послать патч
Если вы нашли недоработку в тестах или неточность/опечатку в условии, то вы можете послать MR
с исправлением в репозиторий курса.
За все исправления начисляются дополнительные баллы в колонке bugs в таблице.
Размер дополнительных баллов зависит от серьёзности исправления и определяется преподавателями.
## Небольшие исправления
Небольшие исправления на <10 строк проще всего послать через веб интерфейс гитлаба.
1. Откройте нужный файл в веб интерфейсе репозитория https://gitlab.com/manytask/itmo-go/public
2. Нажмите на кнопку "Edit". Во всплывающей подсказке нажмите кнопку "Fork".
![](docs/edit-and-fork.png)
3. Внесите изменения в файл. Нажмите "Commit Changes" внизу страницы.
4. Добавьте описание вашего изменения. Нажмите "Submit Merge Request".
## Продвинутые исправления
Для многофайловых исправлений можно сначала сделать исправление локально:
1. Создайте форк https://gitlab.com/manytask/itmo-go/public аналогично тому, что выше.
2. Закоммитьте все локальные изменения, которые вы не хотите добавлять в репозиторий курса.
3. Создайте новую локальную ветку со свежей версией кода из репозитория курса:
```
git fetch origin
git checkout origin/master -b newbranchforupdate
```
4. Внесите локальные изменения и запушьте их в свой форк на [gitlab.com](https://gitlab.com/) (не в `student`), например
```
git add .
git commit -m "Update tests"
git push https://gitlab.com/%USERNAME%/shad-go/
```
5. В своём форке выберите созданную ветку и создайте Merge Request в репозиторий курса. Обычно GitLab подсказывает недавно запушенную ветку и предлагает создать для неё MR.
![](docs/create-mr.png)
На странице c формой нового Merge Request убедитесь, что ветвь назначения `slon/shad-go:master`. Нажмите кнопку "Create Merge Request".
![](docs/create-mr-form.png)