commit c4f110158af735425634ba7195dbd7c907649838 Author: Silverstone Templates Date: Sun Nov 8 19:07:05 2026 +0300 Add project starter documentation and issue templates diff --git a/.forgejo/ISSUE_TEMPLATE/bug.md b/.forgejo/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..3194fab --- /dev/null +++ b/.forgejo/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,21 @@ +--- +name: Ошибка +about: Сообщить о воспроизводимой ошибке +title: "" +--- + +## Что сломалось + +## Как повторить +1. +2. + +## Ожидаемое поведение + +## Фактическое поведение + +## Окружение +ОС, версия приложения, версия движка или runtime, commit. + +## Логи / скриншоты +Перед публикацией удалите пароли, токены и личные данные. diff --git a/.forgejo/ISSUE_TEMPLATE/feature.md b/.forgejo/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..67ca952 --- /dev/null +++ b/.forgejo/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,13 @@ +--- +name: Предложение +about: Предложить улучшение проекта +title: "" +--- + +## Какую проблему решаем + +## Предлагаемое решение + +## Альтернативы + +## Как проверить результат diff --git a/.forgejo/PULL_REQUEST_TEMPLATE.md b/.forgejo/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..32a7a36 --- /dev/null +++ b/.forgejo/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## Что изменено и зачем + +## Связанная задача +Closes #... + +## Как проверено +Команды тестов или шаги ручной проверки. + +## Совместимость и риски +Миграции, изменение настроек, известные ограничения. + +- [ ] Нет паролей, токенов и личных данных +- [ ] Проверки выполнены; либо указано, что не проверялось +- [ ] Документация обновлена при необходимости diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0cfdd0b --- /dev/null +++ b/.gitignore @@ -0,0 +1,86 @@ +# Local secrets; use sanitized example files instead. +.env +.env.* +!.env.example +!.env.sample +.DS_Store +Thumbs.db +Desktop.ini +*.swp +*.swo +*~ + +# Forgejo built-in: Unity +# This .gitignore file should be placed at the root of your Unity project directory +# +# Get latest from https://github.com/github/gitignore/blob/main/Unity.gitignore +# +/[Ll]ibrary/ +/[Tt]emp/ +/[Oo]bj/ +/[Bb]uild/ +/[Bb]uilds/ +/[Ll]ogs/ +/[Uu]ser[Ss]ettings/ + +# MemoryCaptures can get excessive in size. +# They also could contain extremely sensitive data +/[Mm]emoryCaptures/ + +# Recordings can get excessive in size +/[Rr]ecordings/ + +# Uncomment this line if you wish to ignore the asset store tools plugin +# /[Aa]ssets/AssetStoreTools* + +# Autogenerated Jetbrains Rider plugin +/[Aa]ssets/Plugins/Editor/JetBrains* + +# Visual Studio cache directory +.vs/ + +# Gradle cache directory +.gradle/ + +# Autogenerated VS/MD/Consulo solution and project files +ExportedObj/ +.consulo/ +*.csproj +*.unityproj +*.sln +*.suo +*.tmp +*.user +*.userprefs +*.pidb +*.booproj +*.svd +*.pdb +*.mdb +*.opendb +*.VC.db + +# Unity3D generated meta files +*.pidb.meta +*.pdb.meta +*.mdb.meta + +# Unity3D generated file on crash reports +sysinfo.txt + +# Builds +*.apk +*.aab +*.unitypackage +*.app + +# Crashlytics generated file +crashlytics-build.properties + +# Packed Addressables +/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin* + +# Temporary auto-generated Android Assets +/[Aa]ssets/[Ss]treamingAssets/aa.meta +/[Aa]ssets/[Ss]treamingAssets/aa/* + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b325a17 --- /dev/null +++ b/LICENSE @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..0186da5 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Название проекта + +Заготовка для **Unity**. Замените этот текст описанием вашего проекта. +Это шаблон документации, не готовое приложение. + +## Начало работы +Укажите версию Unity. Сохраняйте Assets с .meta-файлами, Packages и ProjectSettings. Для сцен и префабов используйте текстовую сериализацию. + +## Запуск и проверка +Укажите точные команды установки зависимостей, запуска, сборки и тестов. + +## Настройки +Секреты храните вне Git. В .env.example оставляйте только безопасные примеры. +`.gitignore` не удаляет уже закоммиченные секреты и не заменяет проверку файлов. + +## Работа в команде +Описывайте ошибки и предложения через Issues. Для изменений есть шаблон pull request. +Защиту веток включайте в настройках конкретного проекта по договорённости. + +## Крупные файлы +См. [инструкцию Git LFS](docs/LFS.md). Набор форматов выбирает автор проекта. + +## Использование шаблона +Нажмите «Использовать шаблон» / «Use this template», выберите свой аккаунт, +название и видимость нового проекта. Новый проект может быть приватным, +хотя исходный шаблон публичный. Отредактируйте README и .gitignore под проект. +Обновления исходного шаблона не переносятся в созданные проекты автоматически. +Для других стеков при создании пустого репозитория доступен встроенный каталог .gitignore. + +## Лицензия +Содержимое этой заготовки распространяется по CC0-1.0 — см. LICENSE. +Для собственного кода и сторонних ресурсов выберите подходящую лицензию отдельно. diff --git a/docs/LFS.md b/docs/LFS.md new file mode 100644 index 0000000..326727c --- /dev/null +++ b/docs/LFS.md @@ -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-объекты требуют отдельного резервного копирования вместе с репозиториями.