shad-go/CONTRIBUTING.md

45 lines
2.8 KiB
Markdown
Raw Normal View History

2020-02-01 18:14:29 +00:00
# Как послать патч
Если вы нашли недоработку в тестах или неточность/опечатку в условии, то вы можете послать PR
2020-02-01 18:14:29 +00:00
с исправлением в репозиторий курса.
За все исправления начисляются дополнительные баллы в колонке bonus в таблице.
2021-02-11 18:05:25 +00:00
Размер дополнительных баллов зависит от серьёзности исправления и определяется преподавателями.
2020-02-01 18:14:29 +00:00
## Небольшие исправления
Небольшие исправления на <10 строк проще всего послать через веб интерфейс гитхаба.
2020-02-01 18:14:29 +00:00
1. Откройте нужный файл в веб интерфейсе репозитория https://github.com/slon/shad-go
2. Нажмите на кнопку "Edit in place".
![](docs/edit-in-place.png)
3. На следующем экране нажмите "Fork this repository".
3. Внесите изменения в файл. Нажмите "Commit Changes" сверху страницы.
4. Добавьте описание вашего изменения. Нажмите "Propose changed".
5. Нажмите "Create pull request".
## Продвинутые исправления
Для многофайловых исправлений можно сначала сделать исправление локально:
1. Создайте форк https://github.com/slon/shad-go аналогично тому, что выше.
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. Внесите локальные изменения и запушьте их в свой форк на [github.com](https://github.com/) (не в `student`), например
```
git add .
git commit -m "Update tests"
git push https://github.com/%USERNAME%/shad-go/
```
5. В своём форке выберите созданную ветку и создайте Pull Request в репозиторий курса. Обычно Github подсказывает недавно запушенную ветку и предлагает создать для неё PR.
На странице c формой нового Pull Request убедитесь, что ветвь назначения — `slon/shad-go:master`. Нажмите кнопку "Create Pull Request".