Skip to content

Contribution

Ми підтримуємо мінімалістичний підхід до розробки. Зрозуміла архітектура та чистий код важливіші за надмірну документацію всередині функцій.

  1. Форкніть та клонуйте репозиторій

    Terminal window
    git clone https://github.com/ModusTeam/cinema-platform-docs.git
    cd cinema-platform-docs
  2. Встановіть залежності

    Terminal window
    bun install
  3. Запустіть dev-сервер

    Terminal window
    bun dev
  4. Створіть гілку для своїх змін

    Дотримуйтесь конвенції іменування (див. нижче) та вносьте зміни лише у своїй гілці.


Конвенція іменування гілок

Section titled “Конвенція іменування гілок”

Назва гілки має чітко відображати суть змін. Використовуйте наступні префікси:

ПрефіксПризначенняПриклад
feat/Нова сторінка або функціональністьfeat/add-auth-guide
fix/Виправлення помилки або неточностіfix/setup-typo
docs/Оновлення наявного контентуdocs/update-architecture
chore/Технічні зміни (конфіг, залежності)chore/upgrade-starlight

  • Усі статті зберігаються у src/content/docs/ у форматі .md або .mdx
  • Кожен файл обов’язково має frontmatter з title та description
  • Для інтерактивних елементів (Steps, Tabs, Aside) використовуйте .mdx
// Функція без зайвих коментарів — назва говорить сама за себе
function calculateTotalPrice(items: PricingItem[]): number {
return items.reduce((sum, item) => sum + item.price, 0);
}
  • Змінні та функції: camelCase, іменники для змінних, дієслова для функцій (getUserById, seatCount)
  • Компоненти та класи: PascalCase (SeatLockingService, OrderCard)
  • Константи: SCREAMING_SNAKE_CASE (MAX_SEAT_LOCK_DURATION)
  • Файли: kebab-case для .md/.mdx (local-setup.mdx, database-schema.mdx)

Дотримуйтесь наступної структури опису PR:

## Що змінено
Коротко - 1-2 речення про суть змін.
## Чому
Контекст: яку проблему вирішує або яку задачу закриває цей PR.
## Checklist
- [ ] `bun run format` виконано
- [ ] Frontmatter присутній у всіх змінених файлах
- [ ] Зміни протестовано локально (`bun dev`)
Terminal window
# Форматування (Biome)
bun run format
# Перевірка білду
bun run build

Проєкт використовує Biome для форматування та лінтингу. Конфігурація знаходиться у biome.json. Запускайте форматування перед кожним комітом:

Terminal window
bun run format