Add project starter documentation and issue templates
This commit is contained in:
commit
801712ad46
8 changed files with 192 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
|
||||||
82
.gitignore
vendored
Normal file
82
.gitignore
vendored
Normal file
|
|
@ -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
|
||||||
|
|
||||||
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 @@
|
||||||
|
# Название проекта
|
||||||
|
|
||||||
|
Заготовка для **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.
|
||||||
|
Для собственного кода и сторонних ресурсов выберите подходящую лицензию отдельно.
|
||||||
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