From 54f42f20ad304a659a6445ce57e8d7ea574ff0b1 Mon Sep 17 00:00:00 2001 From: Daniil Suvorov Date: Mon, 28 Oct 2024 17:08:43 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20use=20local=20path=20=D0=A3=D0=B4=D0=B0?= =?UTF-8?q?=D0=BB=D0=B8=D0=BB=20=D1=81=D1=81=D1=8B=D0=BB=D0=BA=D0=B8=20?= =?UTF-8?q?=D0=BD=D0=B0=20=D0=B3=D0=B8=D1=82=D1=85=D0=B0=D0=B1=20=D0=BC?= =?UTF-8?q?=D0=B0=D1=81=D1=82=D0=B5=D1=80=D0=B0,=20=D0=B4=D0=BB=D1=8F=20?= =?UTF-8?q?=D0=B1=D0=BE=D0=BB=D0=B5=D0=B5=20=D1=83=D0=B4=D0=BE=D0=B1=D0=BD?= =?UTF-8?q?=D0=BE=D0=B9=20=D0=BD=D0=B0=D0=B2=D0=B8=D0=B3=D0=B0=D1=86=D0=B8?= =?UTF-8?q?=D0=B8=20=D0=B2=D0=BD=D1=83=D1=82=D1=80=D0=B8=20IDE=20=D0=B8=20?= =?UTF-8?q?=D1=87=D1=82=D0=BE=D0=B1=D1=8B=20=D0=BD=D0=B5=20=D0=BB=D0=BE?= =?UTF-8?q?=D0=BC=D0=B0=D0=BB=D0=B8=D1=81=D1=8C=20=D0=BF=D1=80=D0=B8=20?= =?UTF-8?q?=D0=B8=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD=D0=B8=D0=B8=20=D0=B2?= =?UTF-8?q?=20=D0=BC=D0=B0=D1=81=D1=82=D0=B5=D1=80=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/CONTRIBUTING.md | 6 +++--- docs/MAINTAINERS.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e540f59894..d4f701c76d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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` навешиваются на корневой элемент компонента - Свойства, не используемые в коде компонента, навешиваются на **главный** элемент компонента. По умолчанию главным является корневой элемент: @@ -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` diff --git a/docs/MAINTAINERS.md b/docs/MAINTAINERS.md index b65000ffce..4fdc52507a 100644 --- a/docs/MAINTAINERS.md +++ b/docs/MAINTAINERS.md @@ -2,7 +2,7 @@ Данный документ содержит базовую информацию по сопровождению и процессам разработки и будет полезен в первую очередь сопровождающим (maintainers) репозитория **VKUI**. Информацию по правилам работы с кодом можно найти в -[требованиях к разработке](https://github.com/VKCOM/VKUI/blob/master/docs/CONTRIBUTING.md). +[требованиях к разработке](CONTRIBUTING.md). ## Глоссарий @@ -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`-ветках в автоматическом режиме (потому что мы не дублируем