добавлены правила контрибьюции

This commit is contained in:
2026-02-13 00:49:18 +08:00
parent 2f28cc4e2c
commit ff69e50127

55
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,55 @@
# Вклад в проект
Спасибо за интерес к проекту.
## Требования
- Обязательно использовать форматирование `ruff`.
- Обязательно использовать аннотации типов и проверять их через `ty`.
## Быстрый старт(GNU/Linux)
Создайте линковку ./PATH_TO_PROJECT/dcr и ~/.local/bin/dcr
После этого, вы можете использовать команду dcr где угодно
## Стиль кода
- Форматируйте код через `ruff`.
- Держите функции небольшими и сфокусированными.
- Предпочитайте понятные имена вместо "хитрых".
## Типизация
- Добавляйте аннотации типов для нового и изменяемого кода.
- Запускайте `ty` для проверки корректности типов.
## Проверки
Для запуска всех проверок используйте скрипт проекта:
```bash
./check.sh
```
> Скрипт можно запустить из любой папки, указав путь до него: `../check.sh` (или больше `../`, если нужно).
## Запуск инструментов напрямую
```bash
ruff check src
uvx ty check src
```
## Коммиты и PR
- Делайте коммиты понятными.
- В PR указывайте краткое описание и мотивацию изменений.
- Обновляйте документацию при изменении поведения.
## Вопросы
Если что-то непонятно, откройте issue или задайте вопрос в PR.
Также можно задать вопрос напрямую:
- TG: @dexoron
- DS: dexoron