Contribution
Ми підтримуємо мінімалістичний підхід до розробки. Зрозуміла архітектура та чистий код важливіші за надмірну документацію всередині функцій.
Початок роботи
Section titled “Початок роботи”-
Форкніть та клонуйте репозиторій
Terminal window git clone https://github.com/ModusTeam/cinema-platform-docs.gitcd cinema-platform-docs -
Встановіть залежності
Terminal window bun install -
Запустіть dev-сервер
Terminal window bun dev -
Створіть гілку для своїх змін
Дотримуйтесь конвенції іменування (див. нижче) та вносьте зміни лише у своїй гілці.
Конвенція іменування гілок
Section titled “Конвенція іменування гілок”Назва гілки має чітко відображати суть змін. Використовуйте наступні префікси:
| Префікс | Призначення | Приклад |
|---|---|---|
feat/ | Нова сторінка або функціональність | feat/add-auth-guide |
fix/ | Виправлення помилки або неточності | fix/setup-typo |
docs/ | Оновлення наявного контенту | docs/update-architecture |
chore/ | Технічні зміни (конфіг, залежності) | chore/upgrade-starlight |
Стандарти контенту
Section titled “Стандарти контенту”Структура файлів
Section titled “Структура файлів”- Усі статті зберігаються у
src/content/docs/у форматі.mdабо.mdx - Кожен файл обов’язково має frontmatter з
titleтаdescription - Для інтерактивних елементів (
Steps,Tabs,Aside) використовуйте.mdx
Мінімалізм у коді
Section titled “Мінімалізм у коді”// Функція без зайвих коментарів — назва говорить сама за себеfunction calculateTotalPrice(items: PricingItem[]): number { return items.reduce((sum, item) => sum + item.price, 0);}// Ця функція рахує загальну суму// Приймає масив items// Повертає числоfunction calculateTotalPrice(items: PricingItem[]): number { // Використовуємо reduce для ітерації return items.reduce((sum, item) => sum + item.price, 0); // додаємо ціну}Іменування
Section titled “Іменування”- Змінні та функції:
camelCase, іменники для змінних, дієслова для функцій (getUserById,seatCount) - Компоненти та класи:
PascalCase(SeatLockingService,OrderCard) - Константи:
SCREAMING_SNAKE_CASE(MAX_SEAT_LOCK_DURATION) - Файли:
kebab-caseдля.md/.mdx(local-setup.mdx,database-schema.mdx)
Pull Request
Section titled “Pull Request”Дотримуйтесь наступної структури опису PR:
## Що зміненоКоротко - 1-2 речення про суть змін.
## ЧомуКонтекст: яку проблему вирішує або яку задачу закриває цей PR.
## Checklist- [ ] `bun run format` виконано- [ ] Frontmatter присутній у всіх змінених файлах- [ ] Зміни протестовано локально (`bun dev`)Перед створенням PR
Section titled “Перед створенням PR”# Форматування (Biome)bun run format
# Перевірка білдуbun run buildФорматування
Section titled “Форматування”Проєкт використовує Biome для форматування та лінтингу. Конфігурація знаходиться у biome.json. Запускайте форматування перед кожним комітом:
bun run format