Add project starter documentation and issue templates

This commit is contained in:
Silverstone Templates 2026-11-08 19:07:03 +03:00
commit 6b21aed65a
8 changed files with 254 additions and 0 deletions

View file

@ -0,0 +1,21 @@
---
name: Ошибка
about: Сообщить о воспроизводимой ошибке
title: ""
---
## Что сломалось
## Как повторить
1.
2.
## Ожидаемое поведение
## Фактическое поведение
## Окружение
ОС, версия приложения, версия движка или runtime, commit.
## Логи / скриншоты
Перед публикацией удалите пароли, токены и личные данные.

View file

@ -0,0 +1,13 @@
---
name: Предложение
about: Предложить улучшение проекта
title: ""
---
## Какую проблему решаем
## Предлагаемое решение
## Альтернативы
## Как проверить результат

View file

@ -0,0 +1,14 @@
## Что изменено и зачем
## Связанная задача
Closes #...
## Как проверено
Команды тестов или шаги ручной проверки.
## Совместимость и риски
Миграции, изменение настроек, известные ограничения.
- [ ] Нет паролей, токенов и личных данных
- [ ] Проверки выполнены; либо указано, что не проверялось
- [ ] Документация обновлена при необходимости

1
.gitattributes vendored Normal file
View file

@ -0,0 +1 @@
* text=auto

144
.gitignore vendored Normal file
View file

@ -0,0 +1,144 @@
# Local secrets; use sanitized example files instead.
.env
.env.*
!.env.example
!.env.sample
.DS_Store
Thumbs.db
Desktop.ini
*.swp
*.swo
*~
# Forgejo built-in: Node
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
.cache
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

6
LICENSE Normal file
View 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
View file

@ -0,0 +1,32 @@
# Название проекта
Заготовка для **Node.js / JavaScript / TypeScript**. Замените этот текст описанием вашего проекта.
Это шаблон документации, не готовое приложение.
## Начало работы
Добавьте package.json, выберите менеджер пакетов и сохраните его lock-файл. Опишите scripts для запуска и тестов.
## Запуск и проверка
Укажите точные команды установки зависимостей, запуска, сборки и тестов.
## Настройки
Секреты храните вне 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
View 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-объекты требуют отдельного резервного копирования вместе с репозиториями.