Директиви проекту
Цей документ визначає правила та процеси, які слід дотримуватися при ініціюванні, управлінні та внесенні внесків у проекти в межах клубу.
1. Структура проекту
Підтримка послідовної структури проекту допомагає організовувати код та ресурси ефективно. Дотримуйтеся цих правил при структуруванні ваших проектів:
Кореневий каталог: Розмістіть файли, специфічні для проекту (наприклад, README.md, ліцензія) в / (project root).
Вихідний код: Організуйте вихідний код в чіткій структурі (наприклад,
main.rs, handlers/, db/).Документація: Якщо ви плануєте мати документацію - включіть її в
docs/для документації проекту.
2. Контроль версій
Ефективний контроль версій є ключовим для спільної роботи та відстеження змін. Дотримуйтеся цих правил контролю версій:
Вітки: Використовуйте вітки для нових функцій та виправлення помилок.
Повідомлення про коміти: Пишіть чіткі та лаконічні повідомлення про коміти.
Запити на злиття: Створюйте запити на злиття для перегляду коду перед злиттям в основну гілку.
Теги версій: Позначайте релізи номерами версій для зручності посилання.
3. Співпраця
Співпраця - ключ до успішного розвитку проекту. Дотримуйтеся цих правил співпраці:
Зв’язок: Використовуйте канали комунікації проекту для обговорень.
Задачі: Створюйте та відстежуйте завдання за допомогою проблем GitHub.
Рецензії коду: Проводьте ретельні рецензії коду для кожного запиту на злиття.
Внесок в директиви проекту
Якщо у вас є пропозиції чи покращення до цих директив проекту, будь ласка, створіть проблему або надішліть запит на злиття. Ваші відгуки є цінними для забезпечення успіху наших проектів.