Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add maintainers guide #7010

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

BlackySoul
Copy link
Contributor

@BlackySoul BlackySoul commented Jun 11, 2024


Мейби добавить картинок, чтобы было понятнее, куда-что нажимать?

@BlackySoul BlackySoul self-assigned this Jun 11, 2024
@BlackySoul BlackySoul requested a review from a team as a code owner June 11, 2024 15:07
@BlackySoul BlackySoul removed their assignment Jun 11, 2024
Copy link

codesandbox-ci bot commented Jun 11, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

mendrew
mendrew previously approved these changes Jun 13, 2024
Copy link
Contributor

@mendrew mendrew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Шикарно написано! 👏 👏 👏 🎉

А куда бы ты скриншотов добавила?
Вижу, что в местах, где может быть не очень понятно куда жать у тебя есть ссылки на доку, по-моему очень грамотно.

Comment on lines +44 to +45
- при публикации минорного релиза `x.y.0` автоматически создается ветка `x.y-stable` для патчей (например, при публикации минорной версии 6.1.0 будет создана ветка для последующих патчей 6.1-stable).
- если в `PR` указать в `Labels` значение `patch` (происходит автоматически, если название в шапке `PR` начинается с `fix`), то изменения продублируются и в `x.y-stable`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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

Как будто бы для патчей подошло бы другое название ветки, типа x.y-patch 🙂

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нейминг взят от GitLab Flow. x.y-stable говорит о стабильности ветки, а x.y-patch больше похоже на какой-то отдельный патч

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нейминг взят от GitLab Flow. x.y-stable говорит о стабильности ветки, а x.y-patch больше похоже на какой-то отдельный патч

Это да, x.y-patch похоже на какой-то патч, а x.y-stable похоже на какой-то stable))

Понимаю, что из GitLab Flow, но сама по себе стабильная ветка мало что о себе говорит, что значит стабильная, для меня просто значит, что мы её выпустили и туда можно только хот фиксы/патчи отправлять.
В x.y-patch хотя бы слово patch на слуху и хорошо ложится на знание, что сейчас туда патч полетит, или что от туда сейчас следующий патч (версия) вылетит. И в экшенах, наверное, было бы проще на код смотреть.

Но это я придираюсь, потому что часто путаюсь. Для самого подхода такое название имеет смысл, но в прикладном смысле не очень для запоминания) Ничего менять не призываю, конечно, просто жалуюсь)

@BlackySoul
Copy link
Contributor Author

Вижу, что в местах, где может быть не очень понятно куда жать у тебя есть ссылки на доку, по-моему очень грамотно.

Вот вместо ссылок картинки х) Но, кажется, чтобы охватить все, нужны прям картинки всего экрана с пометкой шагами (1, 2...), куда последовательно тыкать. Вот хз, что лучше 🤔

@mendrew
Copy link
Contributor

mendrew commented Jun 13, 2024

Вот вместо ссылок картинки х)

No, no, no, ссылки точно оставить, интерфейс может поменяться, а ссылки хоть покажут где подробнее посмотреть.

Картинки с шагами куда тыкать тоже пригодятся, но это на твоё усмотрение, вообще можно посмотреть как новый человек этот текст прочитает и у него уточнить по поводу картинок 😄

docs/MAINTAINERS.md Outdated Show resolved Hide resolved
Copy link
Contributor

@inomdzhon inomdzhon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

очень мощно 🔥🔥🔥

спасибо 🙏

docs/MAINTAINERS.md Show resolved Hide resolved
docs/MAINTAINERS.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mendrew mendrew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Добавить информацию для сопровождающих
4 participants