From a969e12233105955dcc602108523bd84b8aa5420 Mon Sep 17 00:00:00 2001 From: erjemin Date: Sun, 6 Sep 2026 22:37:45 +0300 Subject: [PATCH] =?UTF-8?q?add:=20=D0=9A=D0=BE=D0=B4=D0=B5=D0=BA=D1=81=20?= =?UTF-8?q?=D0=BF=D0=BE=D0=B2=D0=B5=D0=B4=D0=B5=D0=BD=D0=B8=D1=8F=20=D0=B8?= =?UTF-8?q?=20=D0=9F=D1=80=D0=B0=D0=B2=D0=B8=D0=BB=D0=B0=20=D1=83=D1=87?= =?UTF-8?q?=D0=B0=D1=81=D1=82=D0=B8=D1=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CODE_OF_CONDUCT.md | 34 +++++++++++++++++++++++++++++++ CONTRIBUTING.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 3 files changed, 86 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..94a0c4c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,34 @@ +# Кодекс поведения (CODE OF CONDUCT) + +## 1. Основные принципы + +Мы стремимся создать открытое, продуктивное и уважительное сообщество вокруг проекта **Hypn0**. Все участники, контрибьюторы и мейнтейнеры обязуются соблюдать следующие базовые стандарты взаимодействия: + +- **Уважение и профессионализм:** Проявление доброжелательности и терпения к участникам с любым уровнем опыта. +- **Конструктивная критика:** Фокус на коде, архитектуре и идеях, а не на личностях. +- **Ориентация на результат:** Принятие решений, направленных на развитие функциональности, стабильности и безопасности проекта. + +--- + +## 2. Недопустимое поведение + +В рамках проекта (в issue, pull request, комментариях к коду и обсуждениях) строго запрещены: + +- Оскорбления, уничижительные комментарии и личные нападки. +- Дискриминация в любой форме. +- Публикация чужих персональных данных без согласия (доксинг). +- Спам, троллинг, намеренная дестабилизация обсуждений или накрутка голосов в галерее. + +--- + +## 3. Ответственность и модерация + +Мейнтейнеры проекта несут ответственность за поддержание стандартов общения и имеют право: +- Редактировать или удалять комментарии, issue и pull request, нарушающие данный Кодекс. +- Временно или навсегда блокировать доступ нарушителей к репозиторию и коммуникационным каналам проекта. + +--- + +## 4. Сообщение о нарушениях + +Если вы столкнулись с неприемлемым поведением, сообщите об этом мейнтейнерам проекта через личные сообщения или по электронной почте, указанной в профиле автора репозитория. Все обращения рассматриваются конфиденциально. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d8fd1cb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Руководство по участию в проекте (CONTRIBUTING) + +Благодарим за интерес к развитию проекта **Hypn0**! Мы приветствуем любые улучшения: исправление ошибок, новые генеративные алгоритмы и формы, оптимизацию производительности и дополнение документации. + +--- + +## 1. Сообщение об ошибках и предложения (Issues) + +Нам известно, что проект не идеален. Перед созданием нового issue: +1. Проверьте существующие закрытые и открытые задачи, чтобы избежать дублирования. +2. При сообщении об ошибке укажите: + - Шаги для воспроизведения проблемы. + - Ожидаемое и фактическое поведение. + - Версию окружения (Python, ОС, браузер). +3. При предложении новой функциональности опишите ее практическую ценность и сценарии использования. + +--- + +## 2. Разработка и стандарты кода + +### Окружение +- **Стек:** Python 3.14+, Django 6.0+, Poetry. +- **Фронтенд:** Tailwind CSS, Alpine.js, HTMX (сборка описана в `frontend-assembly/README.md`). + +### Стандарты кодовой базы +- **Стиль Python:** PEP8, Black, isort. Отступы 4 пробела, длина строки до 180-200 символов. +- **Комментарии:** На русском языке, имена функций, классов и переменных — на английском. +- **Эмодзи:** Избегайте использования эмодзи в кодовой базе, коммитах и документации. +- **Тестирование:** Все изменения в логике бэкенда должны сопровождаться или покрываться тестами: + ```bash + python hypn0/manage.py test hypn0_site + ``` + +--- + +## 3. Процесс подачи изменений (Pull Requests / Merge Requests) + +1. Сделайте форк репозитория и создайте отдельную ветку для задачи: `git checkout -b feature/awesome-shape` или `git checkout -b fix/scoring-gravity`. +2. Внесите изменения, соблюдая стиль проекта. +3. Убедитесь, что все автоматические тесты проходят успешно. +4. Оформите краткий и понятный коммит. +5. Откройте Pull Request с описанием сути изменений и ссылкой на связанный issue (если есть). + +--- + +## 4. Лицензирование контрибуций + +Отправляя код или документацию в репозиторий Hypn0, вы соглашаетесь с тем, что ваш вклад будет лицензирован на условиях общей лицензии проекта: +- Исходный код: **PolyForm Noncommercial License 1.0.0**. +- Сгенерированная графика: **Creative Commons Zero 1.0 Universal (CC0 1.0)**. diff --git a/README.md b/README.md index d35fa7a..7ae5180 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ - **Безопасность и приватность:** [SECURITY.md](SECURITY.md) — Zero-PII, правила отслеживания и защита от накруток. - **Планы и архитектура:** [_blueprint/plan-draft.md](_blueprint/plan-draft.md). - **Предыстория:** CLI-утилита [2026-image-hatftone-effect](https://git.cube2.ru/erjemin/2026-image-hatftone-effect). +- **Участие в разработке:** [CONTRIBUTING.md](CONTRIBUTING.md) — стандарты кода и правила для контрибьюторов. +- **Кодекс поведения:** [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — стандарты взаимодействия в сообществе. ---