shad-go/CONTRIBUTING.md

46 lines
2.8 KiB
Markdown
Raw Normal View History

2020-02-01 18:14:29 +00:00
# Как послать патч
Если вы нашли недоработку в тестах или неточность/опечатку в условии, то вы можете послать MR
с исправлением в репозиторий курса.
2021-02-11 18:05:25 +00:00
За все исправления начисляются дополнительные баллы в колонке bugs в таблице.
Размер дополнительных баллов зависит от серьёзности исправления и определяется преподавателями.
2020-02-01 18:14:29 +00:00
## Небольшие исправления
2021-02-13 09:51:33 +00:00
Небольшие исправления на <10 строк проще всего послать через веб интерфейс гитлаба.
2020-02-01 18:14:29 +00:00
2023-10-02 19:32:41 +00:00
1. Откройте нужный файл в веб интерфейсе репозитория https://gitlab.com/manytask/itmo-go/private
2020-02-01 18:14:29 +00:00
2. Нажмите на кнопку "Edit". Во всплывающей подсказке нажмите кнопку "Fork".
![](docs/edit-and-fork.png)
3. Внесите изменения в файл. Нажмите "Commit Changes" внизу страницы.
4. Добавьте описание вашего изменения. Нажмите "Submit Merge Request".
## Продвинутые исправления
Для многофайловых исправлений можно сначала сделать исправление локально:
2023-10-02 19:32:41 +00:00
1. Создайте форк https://gitlab.com/manytask/itmo-go/private аналогично тому, что выше.
2023-02-22 00:20:20 +00:00
2. Закоммитьте все локальные изменения, которые вы не хотите добавлять в репозиторий курса.
3. Создайте новую локальную ветку со свежей версией кода из репозитория курса:
```
git fetch origin
git checkout origin/master -b newbranchforupdate
```
2023-02-22 00:20:20 +00:00
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".
2023-02-22 00:20:20 +00:00
![](docs/create-mr-form.png)