Пользовательские инструкции

Создание пользовательских инструкций для вашей команды

Создавая стандартизированные инструкции для проектов, каждый член команды может работать в рамках согласованных рекомендаций. Начните с документирования технической основы вашего проекта, затем определите информацию, которую необходимо включить. Конкретный объем будет варьироваться в зависимости от команды, но в целом лучше предоставить как можно больше деталей. Создавая подробные инструкции, которым следуют все, вы устанавливаете общее понимание того, как код пишется, тестируется и развертывается в рамках всего проекта, что приводит к созданию более удобного в сопровождении и последовательного программного обеспечения.

---

Ниже приведены некоторые темы и примеры, которые следует учитывать для пользовательских инструкций вашей команды.

1. Фреймворки тестирования и конкретные команды
   • "Все компоненты должны включать тесты Jest с покрытием не менее 85%. Запускайте тесты с помощью npm run test:coverage перед отправкой pull request."
2. Явные предпочтения в отношении библиотек
   • "Используйте React Query для получения данных и управления состоянием. Избегайте Redux, если это абсолютно необходимо для сложного глобального состояния. Для стилизации используйте Tailwind CSS с пользовательской конфигурацией темы в src/styles/theme.js."
3. Места расположения документации
   • "Вся API documentation находится во внутреннем рабочем пространстве Notion в разделе 'Engineering > API Reference'. Примеры использования компонентов находятся в нашем экземпляре Storybook по адресу https://storybook.internal.company.com."
4. MCP servers для использования и их назначение
   • "Для задач базы данных используйте Postgres MCP server с учетными данными, хранящимися в 'Development > Database'. Для развертываний используйте AWS MCP server, для которого требуются роли развертывания в IAM. Инструкции по настройке см. в docs/mcp-setup.md."
5. Правила кодирования для конкретного проекта
   • "Все React components используют PascalCase, а вспомогательные функции используют camelCase. Организуйте компоненты по функциям (а не по типу) в разделе src/components. Всегда используйте TypeScript interfaces для определений prop."