Add project starter documentation and issue templates

This commit is contained in:
Silverstone Templates 2026-11-08 19:07:02 +03:00
commit 11a14f3dbb
8 changed files with 286 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

176
.gitignore vendored Normal file
View file

@ -0,0 +1,176 @@
# Local secrets; use sanitized example files instead.
.env
.env.*
!.env.example
!.env.sample
.DS_Store
Thumbs.db
Desktop.ini
*.swp
*.swo
*~
# Forgejo built-in: Python
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

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 @@
# Название проекта
Заготовка для **Python**. Замените этот текст описанием вашего проекта.
Это шаблон документации, не готовое приложение.
## Начало работы
Создайте окружение: `python -m venv .venv`. Укажите менеджер зависимостей и команду тестов.
## Запуск и проверка
Укажите точные команды установки зависимостей, запуска, сборки и тестов.
## Настройки
Секреты храните вне 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-объекты требуют отдельного резервного копирования вместе с репозиториями.