32 lines
2.4 KiB
Markdown
32 lines
2.4 KiB
Markdown
# Название проекта
|
||
|
||
Заготовка для **Rust**. Замените этот текст описанием вашего проекта.
|
||
Это шаблон документации, не готовое приложение.
|
||
|
||
## Начало работы
|
||
Создайте Cargo.toml и исходники. Проверки: `cargo test`, `cargo fmt --check`. Cargo.lock не исключён — выберите политику проекта явно.
|
||
|
||
## Запуск и проверка
|
||
Укажите точные команды установки зависимостей, запуска, сборки и тестов.
|
||
|
||
## Настройки
|
||
Секреты храните вне Git. В .env.example оставляйте только безопасные примеры.
|
||
`.gitignore` не удаляет уже закоммиченные секреты и не заменяет проверку файлов.
|
||
|
||
## Работа в команде
|
||
Описывайте ошибки и предложения через Issues. Для изменений есть шаблон pull request.
|
||
Защиту веток включайте в настройках конкретного проекта по договорённости.
|
||
|
||
## Крупные файлы
|
||
См. [инструкцию Git LFS](docs/LFS.md). Набор форматов выбирает автор проекта.
|
||
|
||
## Использование шаблона
|
||
Нажмите «Использовать шаблон» / «Use this template», выберите свой аккаунт,
|
||
название и видимость нового проекта. Новый проект может быть приватным,
|
||
хотя исходный шаблон публичный. Отредактируйте README и .gitignore под проект.
|
||
Обновления исходного шаблона не переносятся в созданные проекты автоматически.
|
||
Для других стеков при создании пустого репозитория доступен встроенный каталог .gitignore.
|
||
|
||
## Лицензия
|
||
Содержимое этой заготовки распространяется по CC0-1.0 — см. LICENSE.
|
||
Для собственного кода и сторонних ресурсов выберите подходящую лицензию отдельно.
|