Добавлена документация
This commit is contained in:
19
docs/CONTRIBUTING.md
Normal file
19
docs/CONTRIBUTING.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Contributing to BotPages
|
||||
|
||||
Спасибо за интерес к проекту! Пожалуйста, перед отправкой PR убедитесь, что:
|
||||
|
||||
- Ваш код проходит сборку: `dotnet build`.
|
||||
- Добавлены/обновлены тесты, если уместно.
|
||||
- Следуется стиль кода проекта и включены nullable-аннотации.
|
||||
|
||||
Документация генерируется через `docfx`. См. `docfx.json` в корне репозитория и скрипты в `scripts/`.
|
||||
|
||||
Пример локальной генерации документации:
|
||||
|
||||
```bash
|
||||
# Unix
|
||||
./scripts/generate-docs.sh
|
||||
|
||||
# Windows PowerShell
|
||||
./scripts/generate-docs.ps1
|
||||
```
|
||||
Reference in New Issue
Block a user