Docs/update readme and contributors

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guidelines 🤝
+
+Добро пожаловать в проект! Чтобы поддерживать высокое качество кода и чистоту истории коммитов, мы следуем строгим стандартам разработки.
+
+## 1. Workflow (Работа с ветками)
+
+Мы используем **Trunk-based** подход. Это означает, что `main` (trunk) — единственный источник истины.
+
+- **Запрет на прямые пуши:** Пуш напрямую в `main` (или `master/dev`) строго запрещен. Любые изменения вносятся **только через Pull Request (PR)**.
+- **Code Review:** Каждый PR должен пройти обязательное код-ревью перед мерджем.
+- **Short-lived branches:** Ветки должны быть короткими (1-2 дня).
+
+**Правила именования веток:**
+
+- `feat/` — для новых функциональных возможностей.
+- `fix/` — для исправления багов.
+- `refactor/` — для переписывания кода без изменения логики.
+- `docs/` — для обновления документации.
+
+## 2. Commit Message Convention
+
+Мы используем стандарт **Conventional Commits**. Это позволяет автоматически генерировать логи изменений и поддерживать историю в чистоте.
+
+**Формат:** `<type>(<scope>): <description>`
+
+- **Пример:** `feat(database): add user entity and drizzle migrations`
+- **Пример:** `fix(auth): resolve jwt expiration issue`
+
+## 3. Разработка и стандарты кода
+
+- **Validation (Zod):** Использование схем **Zod** для эндпоинтов (DTO) обязательно. Без них не будет работать валидация данных и автоматическая типизация в Swagger.
+- **Linting & Formatting:** Перед каждым коммитом обязательно запускайте `pnpm lint` и `pnpm format`. Код, не прошедший проверку линтером, не будет принят.
+- **Drizzle Migrations:** **Никаких ручных изменений в базе данных.** Все изменения схем должны сопровождаться миграциями.
+    - Команда: `pnpm db:generate`
+- **No God-commits:** Разделяйте свои изменения на небольшие логические коммиты.
+
+## 4. Pull Request (PR) Process
+
+Прежде чем отправить PR, убедитесь, что:
+
+1. **Self-Review:** Вы сами перечитали свой код и удалили отладочные логи (`console.log`).
+2. **Checks:** Все автоматические тесты (`pnpm test`) и линтер проходят успешно.
+3. **Description:** В описании PR четко указано, что именно было сделано и зачем.
+
+_PR не принимается, если тесты или линтер упали на этапе CI._
+
+## 5. Local Setup
+
+Для быстрой настройки локального окружения обратитесь к разделу **Quick Start** в [README.md](./README.md).
+
+Краткий список команд для старта:
+
+```bash
+pnpm install
+cp .env.example .env
+pnpm db:generate
+pnpm db:migrate
+pnpm start:dev
+```

README.md

@@ -1,2 +1,55 @@
-# task-tracker-backend
-Task-tracker-backend
+# Task Tracker Backend 🚀
+
+Современная лёгкая open-source система управления IT-проектами (альтернатива Jira/Yandex Tracker). Бэкенд построен на высокопроизводительном стеке с упором на типизацию и скорость разработки.
+
+**Статус:** `In Development`
+
+## Технологический стек
+
+- **Runtime:** Node.js 22+ (pnpm)
+- **Framework:** NestJS 11 (**Fastify**)
+- **Database:** PostgreSQL + **Drizzle ORM**
+- **Validation:** Zod
+- **API:** Swagger (OpenAPI)
+- **Infrastructure:** Docker (Multi-stage builds)
+- **Testing:** Vitest
+
+## Quick Start
+
+### 1. Окружение
+
+Скопируйте пример файла окружения и настройте переменные (БД, API ключи DeepSeek):
+
+```bash
+cp .env.example .env
+```
+
+### 2. Запуск через Docker (Рекомендуется)
+
+Проект полностью контейнеризирован:
+
+```bash
+docker-compose up --build
+```
+
+### 3. Локальный запуск
+
+Если вы хотите запустить проект без Docker:
+
+```bash
+pnpm install
+pnpm db:generate
+pnpm db:migrate
+pnpm start:dev
+```
+
+## API Documentation
+
+После запуска проекта документация доступна по адресу:
+
+**http://localhost:3000/api/v1/docs**
+
+## Infrastructure
+
+- CI/CD: Настроены GitHub Actions для автоматической проверки типов, линтинга и запуска тестов.
+- Docker: Используются оптимизированные multi-stage образы для минимизации размера production-билда.