Инструкция по работе с репозиторием

Правила работы

• Репозиторий используется для командной работы над проектом.
• Для решения каждой задачи требуется создать отдельную ветку.
• Merge веток в main происходит через Pull Request (далее PR).
• Прямые push-коммиты в main запрещены.
• Названия всех коммитов и веток должны согласовываться с установленными правилами именования.
• Для каждого PR требуется согласование от всех членов команды.

Именование

При именовании коммитов требуется придерживаться конвенциональных правил именования коммитов (www.conventionalcommits.org/en/v1.0.0)

<тип>[дополнительная часть]: <описание>

Комментарий коммита должен содержать описание подробное описание внесённых изменений.

Стандартные типы коммитов:

• feat
• fix
• chore
• docs
• style
• refactor
• test
• Возможны другие типы при осознанном использовании

Именование веток предполагается делать по следующему шаблону: <тип>/<описание>

Список разрешенных типов соответствует стандартным типам коммитов.

Pull Request и система аппрувов

1. Для каждого изменения создается новая ветка.
2. После завершения работы над изменением создается PR в main.
3. Pull Request должен содержать описание сути изменений.
4. После получения нужного числа approve'ов PR вливается в main.
5. Если есть замечания — PR не принимается до их устранения.

Структура репозитория

├── docs/
│ └── instruction.md - инструкция по работе с репозиторием
│
├── content/
│ ├── questionnaire.md - анкета для заказчика
│ ├── questionnaire.pdf - анкета для заказчика в итоговом формате 
│ ├── interview.pdf - протокол интервью
│ └── communication-plan.pdf - план коммуникаций
│
├── README.md
└── .gitignore