На главную
Контейнеры и CI/CD
Файлы сообщества репозитория
Файлы, которые GitHub показывает контрибьютору: как помочь проекту, кодекс поведения, куда писать об уязвимости, шаблоны задач и пулл-реквеста, CODEOWNERS.
Какие файлы нужны
Чем заполнить
Логин или команда на GitHub
Например 2.x
Можно пусто
Файлы
CONTRIBUTING.md
# Как помочь проекту «Мой проект» Спасибо, что хотите помочь. Ниже — самое короткое, что нужно знать. ## С чего начать 1. Заведите обсуждение или задачу, прежде чем писать большой код: так вы не потратите вечер на то, что уже делает кто-то другой. 2. Форк, ветка от `main`, имя ветки — по смыслу: `fix/upload-timeout`, `feat/csv-export`. ## Локальный запуск ```bash npm ci npm test ``` ## Перед пулл-реквестом - тесты проходят: `npm test`; - линтер молчит: `npm run lint`; - на новое поведение есть тест, который падает без вашей правки; - одна правка — один коммит и один пулл-реквест: так его проще прочитать и откатить. ## Сообщения коммитов Короткая строка в повелительном наклонении, при желании — префикс области: `fix(upload): не терять файлы больше 2 ГБ`. ## Ревью Мы стараемся ответить за несколько дней. Замечания — про код, а не про человека; если правку не приняли, в ответе будет причина.
Шаблоны задач лежат в .github/ISSUE_TEMPLATE и пишутся в формате форм: GitHub покажет поля, а не пустое окно, и вы получите версию, шаги и ожидаемое поведение сразу, без переписки. SECURITY.md — единственное место, где вы просите не открывать публичную задачу; без него об уязвимости узнают все одновременно с вами.