docs(README): переработка структуры, добавлен LICENSE (MIT) и CONTRIBUTING

- README сокращён с 449 до ~200 строк
- Добавлены бейджи (Python, Node, Docker, лицензия) и оглавление
- Раздел возможностей — акцент на LLM-перевод контента БД как главную фичу
- Enterprise Clean вынесен в docs/enterprise-clean.md
- Авторизация, мониторинг, обновление — сокращены до минимума
- Создан LICENSE (MIT)
- Создан CONTRIBUTING.md
- Примеры переведены в промышленный контекст
This commit is contained in:
2026-06-11 19:10:31 +03:00
parent 06ced7608d
commit 5623a8156a
4 changed files with 363 additions and 335 deletions

32
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,32 @@
# Contributing to ss-tools
Спасибо за интерес к проекту! Мы принимаем contributions через pull request.
## Как помочь
- **Сообщить об ошибке** — создайте [issue](https://github.com/anomalyco/ss-tools/issues/new)
- **Предложить идею** — создайте issue с меткой `enhancement`
- **Исправить баг** — форкните репозиторий, сделайте PR
## Процесс
1. Форкните репозиторий
2. Создайте ветку: `git checkout -b feature/your-feature`
3. Внесите изменения
4. Убедитесь, что тесты проходят:
```bash
cd backend && pytest
cd frontend && npm run test
```
5. Сделайте коммит и push
6. Откройте Pull Request
## Code Style
- **Python**: PEP 8, используйте `black` + `ruff`
- **Svelte**: Svelte 5 Runes, Tailwind CSS
- **Коммиты**: пишите на русском или английском, описывайте суть изменений
## Лицензия
Внося contribution, вы соглашаетесь, что ваш код будет распространяться под [MIT License](LICENSE).