🛠 Чек-лист по настройке и ведению репозитория .NET-проекта
Составили для вас чек-лист для организации репозитория .NET-проекта. Получился мини-гайд, который можно скинуть джуну.
• Убедитесь, что имя аккаунта, название репозитория и основная ветка (main или master) соответствуют соглашениям команды.
• Проверьте, нет ли опечаток или лишних символов в пути.
• Поместите в корень проекта файл с лицензией (MIT, Apache, GPL и т. д.).
• Проверьте, что текст лицензии актуален и соответствует требованиям компании.
• Используйте готовые шаблоны для .NET (VisualStudio, Rider): исключите bin/, obj/, настройки IDE, файлы сборки.
• При необходимости добавьте игнорацию пользовательских секретов и сертификатов.
bin/
obj/
*.user
*.suo
Задайте нормализацию переводов строк:
* text=auto
*.ps1 text eol=crlf
• Укажите специальные правила для бинарных файлов, чтобы избежать проблем с кодировкой.
• Опишите назначение проекта, его архитектуру и ключевые зависимости.
• Дайте инструкции по установке, настройке и запуску (команды CLI, порты, переменные окружения).
• Приведите пример запуска основных сценариев.
• Создайте отдельный тестовый проект (.Tests) и убедитесь, что все тесты проходят при команде
dotnet test
.• Добавьте в README badge с процентом покрытия (например, через Coveralls или Azure Pipelines).
• Разместите workflow в .github/workflows/ci.yml: сборка, тесты, анализ кода.
• Опционально — настройте деплой на тестовый или продакшен-стенд.
name: CI
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-dotnet@v1
with: { dotnet-version: '7.0.x' }
- run: dotnet build --no-restore
- run: dotnet test --no-build --verbosity normal
• CODE_OF_CONDUCT.md определяет правила поведения участников.
• CONTRIBUTING.md описывает, как создавать issue, форкать проект и оформлять PR.
• Настройте лейблы для Issue/PR: bug, enhancement, help wanted, good first issue.
• Добавьте в репозиторий релевантные темы (например, csharp, dotnet-core, webapi).
• Статус сборки (Build Passing/Failing).
• Процент покрытия тестами.
• Поддерживаемые версии .NET.
Сколько «галочек» из списка содержит ваш проект?