Add project starter documentation and issue templates
This commit is contained in:
Silverstone Templates
commit
c2071927b1
8 changed files with 125 additions and 0 deletions
21
.forgejo/ISSUE_TEMPLATE/bug.md
Normal file
21
.forgejo/ISSUE_TEMPLATE/bug.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
name: Ошибка
|
||||
about: Сообщить о воспроизводимой ошибке
|
||||
title: ""
|
||||
---
|
||||
|
||||
## Что сломалось
|
||||
|
||||
## Как повторить
|
||||
1.
|
||||
2.
|
||||
|
||||
## Ожидаемое поведение
|
||||
|
||||
## Фактическое поведение
|
||||
|
||||
## Окружение
|
||||
ОС, версия приложения, версия движка или runtime, commit.
|
||||
|
||||
## Логи / скриншоты
|
||||
Перед публикацией удалите пароли, токены и личные данные.
|
||||
13
.forgejo/ISSUE_TEMPLATE/feature.md
Normal file
13
.forgejo/ISSUE_TEMPLATE/feature.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
name: Предложение
|
||||
about: Предложить улучшение проекта
|
||||
title: ""
|
||||
---
|
||||
|
||||
## Какую проблему решаем
|
||||
|
||||
## Предлагаемое решение
|
||||
|
||||
## Альтернативы
|
||||
|
||||
## Как проверить результат
|
||||
14
.forgejo/PULL_REQUEST_TEMPLATE.md
Normal file
14
.forgejo/PULL_REQUEST_TEMPLATE.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
## Что изменено и зачем
|
||||
|
||||
## Связанная задача
|
||||
Closes #...
|
||||
|
||||
## Как проверено
|
||||
Команды тестов или шаги ручной проверки.
|
||||
|
||||
## Совместимость и риски
|
||||
Миграции, изменение настроек, известные ограничения.
|
||||
|
||||
- [ ] Нет паролей, токенов и личных данных
|
||||
- [ ] Проверки выполнены; либо указано, что не проверялось
|
||||
- [ ] Документация обновлена при необходимости
|
||||
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
* text=auto
|
||||
15
.gitignore
vendored
Normal file
15
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Local secrets; use sanitized example files instead.
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
!.env.sample
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
Desktop.ini
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
/build/
|
||||
/cmake-build-*/
|
||||
CMakeUserPresets.json
|
||||
/.vs/
|
||||
6
LICENSE
Normal file
6
LICENSE
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
SPDX-License-Identifier: CC0-1.0
|
||||
|
||||
To the extent possible under law, the contributors waive copyright and related
|
||||
rights to the original starter documentation in this template under CC0 1.0.
|
||||
Built-in .gitignore material retains its upstream terms and comments.
|
||||
https://creativecommons.org/publicdomain/zero/1.0/legalcode
|
||||
32
README.md
Normal file
32
README.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Название проекта
|
||||
|
||||
Заготовка для **C / C++ / CMake**. Замените этот текст описанием вашего проекта.
|
||||
Это шаблон документации, не готовое приложение.
|
||||
|
||||
## Начало работы
|
||||
Укажите компилятор и зависимости. Для CMake: `cmake -S . -B build`, затем `cmake --build build`. Команда требует CMakeLists.txt вашего проекта.
|
||||
|
||||
## Запуск и проверка
|
||||
Укажите точные команды установки зависимостей, запуска, сборки и тестов.
|
||||
|
||||
## Настройки
|
||||
Секреты храните вне Git. В .env.example оставляйте только безопасные примеры.
|
||||
`.gitignore` не удаляет уже закоммиченные секреты и не заменяет проверку файлов.
|
||||
|
||||
## Работа в команде
|
||||
Описывайте ошибки и предложения через Issues. Для изменений есть шаблон pull request.
|
||||
Защиту веток включайте в настройках конкретного проекта по договорённости.
|
||||
|
||||
## Крупные файлы
|
||||
См. [инструкцию Git LFS](docs/LFS.md). Набор форматов выбирает автор проекта.
|
||||
|
||||
## Использование шаблона
|
||||
Нажмите «Использовать шаблон» / «Use this template», выберите свой аккаунт,
|
||||
название и видимость нового проекта. Новый проект может быть приватным,
|
||||
хотя исходный шаблон публичный. Отредактируйте README и .gitignore под проект.
|
||||
Обновления исходного шаблона не переносятся в созданные проекты автоматически.
|
||||
Для других стеков при создании пустого репозитория доступен встроенный каталог .gitignore.
|
||||
|
||||
## Лицензия
|
||||
Содержимое этой заготовки распространяется по CC0-1.0 — см. LICENSE.
|
||||
Для собственного кода и сторонних ресурсов выберите подходящую лицензию отдельно.
|
||||
23
docs/LFS.md
Normal file
23
docs/LFS.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# Крупные файлы и Git LFS
|
||||
|
||||
LFS на сервере уже включён. На каждом компьютере установите Git LFS и выполните:
|
||||
|
||||
```sh
|
||||
git lfs install
|
||||
git lfs track "*.psd"
|
||||
git add .gitattributes
|
||||
git add path/to/asset.psd
|
||||
git commit -m "Add asset through Git LFS"
|
||||
git push
|
||||
```
|
||||
|
||||
Путь замените своим. Для игровых проектов можно явно выбрать `*.blend`, `*.fbx`,
|
||||
`*.uasset`, `*.umap`, WAV или другие крупные бинарные форматы.
|
||||
Автоматических LFS-правил в шаблоне нет: не все изображения и архивы должны идти в LFS.
|
||||
Проверки: `git lfs ls-files`, `git lfs status`.
|
||||
|
||||
`git lfs track` не переносит старую историю автоматически. Не запускайте
|
||||
`git lfs migrate import --everything` в общем проекте без резервной копии
|
||||
и согласования: команда может переписать историю и потребовать force push.
|
||||
|
||||
LFS-объекты требуют отдельного резервного копирования вместе с репозиториями.
|
||||
Loading…
Add table
Reference in a new issue