Skip to content

Commit

Permalink
docs: Some fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Varg committed Jul 25, 2024
1 parent 1610f34 commit 1e0e723
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/co-development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@

В хранилище используется [распространенное соглашение об именовании коммитов](https://www.conventionalcommits.org/en/v1.0.0/).

* Как только pull request создастся, запустятся тесты (они определены в `.github/workflows/test-deploy.yml`. Они проверят, всё ли у в порядке с Вашими изменениями
* Как только pull request создастся, запустятся тесты (они определены в `.github/workflows/test-deploy.yml`. Они проверят, всё ли у в порядке с вашими изменениями

* Сообщите в ИФню, пускай Ваш Pull Request кто-нибудь одобрит, и ждите
* Сообщите в ИФню, пускай ваш Pull Request кто-нибудь одобрит, и ждите

Как только Ваш Pull Request одобрят, Ваша ветка сольется с веткой `main`, автоматически запустится развертывание проекта (это настраивается в `.github/workflows\deploy.yml`), и через какое-то время можно будет увидеть изменения на сайте документации.
Как только ваш Pull Request одобрят, ваша ветка сольется с веткой `main`, автоматически запустится развертывание проекта (это настраивается в `.github/workflows\deploy.yml`), и через какое-то время можно будет увидеть изменения на сайте документации.

После слияния ветки, она становится ненужна, и ее нужно удалить, чтобы не мешалась:

Expand All @@ -119,9 +119,9 @@
## Одобрение Pull Request
Если у Вас есть права, то одобрить Pull Request можно тремя способами:
Если у вас есть права, то одобрить Pull Request можно тремя способами:
* `squash` — т.е. все коммиты с твоей ветки соединяются в один коммит (*если не уверены, то используйте этот метод*)
* `squash` — все коммиты с вашей ветки соединяются в один коммит (*если не уверены, то используйте этот метод*)
Это надо, чтобы вот этот поток бессознательного:
Expand All @@ -138,14 +138,14 @@
* `rebase` — эта штука сливает новые коммиты в `main`
Если у тебя осмысленные коммиты, в духе:
Можно использовать, если у вас осмысленные коммиты, в духе:
```text
docs(syntax-highlighting): start writing an article
docs(syntax-highlighting): write shortly description of what syntax highlighting is
...
```
Тогда это всё не стыдно кинуть прямо в `main` в таком виде.
Тогда всё это не стыдно кинуть прямо в `main` в таком виде.
* еще что-то, что сливает ветку через коммит. Забыл, как называется

0 comments on commit 1e0e723

Please sign in to comment.