Skip to content

Commit

Permalink
docs: use local path (#7834)
Browse files Browse the repository at this point in the history
Удалил ссылки на гитхаб мастера, для более удобной навигации внутри IDE и чтобы не ломались при изменении в мастере
  • Loading branch information
SevereCloud authored Oct 29, 2024
1 parent e44a13f commit 3b3efa5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
> Не используем композицию, т.к. в ней нет необходимости,
> а также в будущем она может усложнить переход на другое решение.
- CSS-классы должны быть в формате camelCase: `elementNameModification`. [Гайд по написанию стилей](https://github.com/VKCOM/VKUI/blob/master/docs/CSS_GUIDE.md)
- CSS-классы должны быть в формате camelCase: `elementNameModification`. [Гайд по написанию стилей](CSS_GUIDE.md)
- Свойства `className` и `style` навешиваются на корневой элемент компонента
- Свойства, не используемые в коде компонента, навешиваются на **главный** элемент компонента. По умолчанию главным является корневой элемент:

Expand Down Expand Up @@ -83,10 +83,10 @@ git config blame.ignoreRevsFile .git-blame-ignore-revs
- Для цветов, скруглений, размеров, отступов и теней используются css-переменные из [vkui-tokens](https://github.com/VKCOM/vkui-tokens)
- Для типографии используются компоненты [Typography](https://vkcom.github.io/VKUI/#!/Typography) там, где это возможно
- Добавлен `export` компонента и его свойств в `packages/vkui/src/index.ts`
- Компонент покрыт юнит- и скриншотными тестами. [Гайд по тестированию](https://github.com/VKCOM/VKUI/blob/master/docs/TESTING.md)
- Компонент покрыт юнит- и скриншотными тестами. [Гайд по тестированию](TESTING.md)
- Компонент корректно отображается на всех платформах, размерах и цветовых схемах. В styleguide для всех этих параметров есть переключатели
- Код корректно работает на [поддерживаемых нами браузерах](https://github.com/VKCOM/VKUI#%D0%B1%D1%80%D0%B0%D1%83%D0%B7%D0%B5%D1%80%D1%8B)
- Для поддержки адаптивности следует придерживаться [гайда по написанию адаптивных компонентов](https://github.com/VKCOM/VKUI/blob/master/docs/ADAPTIVITY_GUIDE.md)
- Для поддержки адаптивности следует придерживаться [гайда по написанию адаптивных компонентов](ADAPTIVITY_GUIDE.md)
- `a11y` (см. пример хорошего PR с внедрением доступности, на который можно равняться [#3337](https://github.com/VKCOM/VKUI/issues/3337)):

- Компонент соответствует требованиям `a11y`
Expand Down
4 changes: 2 additions & 2 deletions docs/MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Данный документ содержит базовую информацию по сопровождению и процессам разработки и будет полезен в первую очередь
сопровождающим (maintainers) репозитория **VKUI**. Информацию по правилам работы с кодом можно найти в
[требованиях к разработке](https://github.com/VKCOM/VKUI/blob/master/docs/CONTRIBUTING.md).
[требованиях к разработке](CONTRIBUTING.md).

## Глоссарий

Expand Down Expand Up @@ -160,7 +160,7 @@
дедупликацию зависимостей в ветке. Если безопасно вносить изменения в ветку напрямую, то можно отметить `push directly to the branch`,
иначе будет создан `PR` с изменениями в выбранную ветку. Бывает полезно запускать эту автоматизацию после обновления
зависимостей в ветке - у нас настроен [Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide),
который [обновляет зависимости](https://github.com/VKCOM/VKUI/blob/master/.github/dependabot.yml) в начале каждой недели.
который [обновляет зависимости](../.github/dependabot.yml) в начале каждой недели.
- [Update screenshots](https://github.com/VKCOM/VKUI/actions/workflows/update_screens.yml): данная автоматизация
позволяет запускать обновление скриншотов в выбранной ветке вручную (если вы забыли это сделать локально, например),
а так же отвечает за обновление скриншотов в `stable`-ветках в автоматическом режиме (потому что мы не дублируем
Expand Down

0 comments on commit 3b3efa5

Please sign in to comment.