From 801712ad469c4dff9f0918f6e8ec979f9a4fefb6 Mon Sep 17 00:00:00 2001 From: Silverstone Templates Date: Sun, 8 Nov 2026 19:07:08 +0300 Subject: [PATCH] Add project starter documentation and issue templates --- .forgejo/ISSUE_TEMPLATE/bug.md | 21 ++++++++ .forgejo/ISSUE_TEMPLATE/feature.md | 13 +++++ .forgejo/PULL_REQUEST_TEMPLATE.md | 14 +++++ .gitattributes | 1 + .gitignore | 82 ++++++++++++++++++++++++++++++ LICENSE | 6 +++ README.md | 32 ++++++++++++ docs/LFS.md | 23 +++++++++ 8 files changed, 192 insertions(+) create mode 100644 .forgejo/ISSUE_TEMPLATE/bug.md create mode 100644 .forgejo/ISSUE_TEMPLATE/feature.md create mode 100644 .forgejo/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docs/LFS.md 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..3f5f827 --- /dev/null +++ b/.gitignore @@ -0,0 +1,82 @@ +# Local secrets; use sanitized example files instead. +.env +.env.* +!.env.example +!.env.sample +.DS_Store +Thumbs.db +Desktop.ini +*.swp +*.swo +*~ + +# Forgejo built-in: Java +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +# Dependency JARs: review before adding a rule. +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* +replay_pid* + + +# Forgejo built-in: Gradle +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + + +# Forgejo built-in: Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties +# https://github.com/takari/maven-wrapper#usage-without-binary-jar +.mvn/wrapper/maven-wrapper.jar + +# Eclipse m2e generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + 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..5c5ae7e --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Название проекта + +Заготовка для **Java / Gradle / Maven**. Замените этот текст описанием вашего проекта. +Это шаблон документации, не готовое приложение. + +## Начало работы +Выберите Gradle или Maven. Сохраняйте wrapper и его JAR. Укажите JDK и команды сборки и тестов. + +## Запуск и проверка +Укажите точные команды установки зависимостей, запуска, сборки и тестов. + +## Настройки +Секреты храните вне 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-объекты требуют отдельного резервного копирования вместе с репозиториями.