mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 13:38:30 +00:00
translated CONTRIBUTING.md to eng
This commit is contained in:
@@ -1,13 +1,13 @@
|
|||||||
# Вклад в проект
|
# Contributing
|
||||||
|
|
||||||
Спасибо за интерес к проекту.
|
Thanks for your interest in the project.
|
||||||
|
|
||||||
## Требования
|
## Requirements
|
||||||
|
|
||||||
- Использовать Rust stable.
|
- Use Rust stable.
|
||||||
- Перед PR код должен проходить форматирование, линт и сборку.
|
- Before opening a PR, the code must pass formatting, linting, and build.
|
||||||
|
|
||||||
## Быстрый старт
|
## Quick Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/dexoron/dcr.git
|
git clone https://github.com/dexoron/dcr.git
|
||||||
@@ -15,16 +15,16 @@ cd dcr
|
|||||||
cargo check
|
cargo check
|
||||||
```
|
```
|
||||||
|
|
||||||
## Стиль кода
|
## Code Style
|
||||||
|
|
||||||
- Форматируйте код через `cargo fmt`.
|
- Format code with `cargo fmt`.
|
||||||
- Проверяйте предупреждения через `cargo clippy`.
|
- Check warnings with `cargo clippy`.
|
||||||
- Держите функции небольшими и сфокусированными.
|
- Keep functions small and focused.
|
||||||
- Предпочитайте понятные имена вместо "хитрых".
|
- Prefer clear names over clever ones.
|
||||||
|
|
||||||
## Проверки
|
## Checks
|
||||||
|
|
||||||
Перед PR запускайте:
|
Before PR, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo fmt --all
|
cargo fmt --all
|
||||||
@@ -32,26 +32,26 @@ cargo clippy --all-targets --all-features -- -D warnings
|
|||||||
cargo check
|
cargo check
|
||||||
```
|
```
|
||||||
|
|
||||||
## CI/CD и релизы
|
## CI/CD and Releases
|
||||||
|
|
||||||
- CI: `.github/workflows/ci.yml`
|
- CI: `.github/workflows/ci.yml`
|
||||||
- Release: `.github/workflows/release.yml`
|
- Release: `.github/workflows/release.yml`
|
||||||
- Релиз запускается по тегу `v*` и публикует бинарники для:
|
- Releases are triggered by tags `v*` and publish binaries for:
|
||||||
- `x86_64-unknown-linux-gnu`
|
- `x86_64-unknown-linux-gnu`
|
||||||
- `x86_64-apple-darwin`
|
- `x86_64-apple-darwin`
|
||||||
- `aarch64-apple-darwin`
|
- `aarch64-apple-darwin`
|
||||||
- `x86_64-pc-windows-msvc`
|
- `x86_64-pc-windows-msvc`
|
||||||
|
|
||||||
## Коммиты и PR
|
## Commits and PRs
|
||||||
|
|
||||||
- Делайте коммиты понятными.
|
- Write clear commit messages.
|
||||||
- В PR указывайте краткое описание и мотивацию изменений.
|
- In PRs, include a short description and rationale.
|
||||||
- Обновляйте документацию при изменении поведения.
|
- Update documentation when behavior changes.
|
||||||
|
|
||||||
## Вопросы
|
## Questions
|
||||||
|
|
||||||
Если что-то непонятно, открой issue или задайте вопрос в PR.
|
If anything is unclear, open an issue or ask in the PR.
|
||||||
|
|
||||||
Также можно задать вопрос напрямую:
|
You can also reach out directly:
|
||||||
- TG: @dexoron
|
- TG: @dexoron
|
||||||
- DS: dexoron
|
- DS: dexoron
|
||||||
|
|||||||
Reference in New Issue
Block a user