Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,43 @@ See [ROADMAP.md](ROADMAP.md) for the current improvement backlog.
- Linux (x86_64, aarch64)
- Android/Termux — see [docs/termux.md](docs/termux.md); native Slint Android spike is tracked in [docs/android.md](docs/android.md)

## Optional Jujutsu Workflow

`jj` is reasonable here only as an optional local workflow on top of the
existing Git repository. It can improve local iteration with operation log,
conflict recovery, and cleaner in-progress history, but it should not replace
the project's canonical GitHub flow.

Recommended stance:

- Use `jj` only if a developer or agent already prefers it locally.
- Keep GitHub Issues, branches, PRs, and remote state managed through `git` +
`gh`.
- Do not require `jj` in CI, build scripts, onboarding, or AGENTS workflow.
- Do not add `vcs-jj` or `vcs-core` unless a future automation issue proves
they solve a concrete project problem.

Minimal issue workflow with `jj`:

```bash
jj git clone https://github.com/xodapi/vimit.git
cd vimit
gh issue view 138
git checkout -b issue-138-evaluate-optional-jujutsu-workflow
jj bookmark create issue-138-evaluate-optional-jujutsu-workflow -r @

# edit files, then verify the required check
cargo fmt --check

# when ready, sync the current jj commit to the Git branch and push normally
jj git push --bookmark issue-138-evaluate-optional-jujutsu-workflow
gh pr create --base main --title "docs(dev): evaluate optional Jujutsu workflow" --body "Closes #138"
```

If you use `jj`, treat it as a personal productivity layer. The repository
still expects Git-compatible branch names, standard commits, and the same issue
assignment / PR review flow documented in `AGENTS.md`.

## Tests

```bash
Expand Down
37 changes: 37 additions & 0 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,43 @@ https://github.com/xodapi/vimit/discussions
- Linux (x86_64, aarch64)
- Android/Termux — см. [docs/termux.md](docs/termux.md); native Slint Android spike описан в [docs/android.md](docs/android.md)

## Optional Jujutsu Workflow

`jj` здесь уместен только как optional локальный workflow поверх уже
существующего Git-репозитория. Он может сделать локальные итерации удобнее за
счёт operation log, более мягкого восстановления после конфликтов и аккуратной
истории промежуточных изменений, но не должен заменять canonical GitHub flow
проекта.

Рекомендация по проекту:

- Использовать `jj` только если разработчику или агенту он уже удобен локально.
- GitHub Issues, ветки, PR и remote state оставлять на `git` + `gh`.
- Не делать `jj` обязательным для CI, build scripts, onboarding или AGENTS workflow.
- Не добавлять `vcs-jj` или `vcs-core`, пока отдельный automation issue не
докажет, что это решает конкретную проблему проекта.

Минимальный issue workflow с `jj`:

```bash
jj git clone https://github.com/xodapi/vimit.git
cd vimit
gh issue view 138
git checkout -b issue-138-evaluate-optional-jujutsu-workflow
jj bookmark create issue-138-evaluate-optional-jujutsu-workflow -r @

# правки, затем обязательная проверка
cargo fmt --check

# когда всё готово, синхронизировать текущий jj commit с Git-веткой и пушить как обычно
jj git push --bookmark issue-138-evaluate-optional-jujutsu-workflow
gh pr create --base main --title "docs(dev): evaluate optional Jujutsu workflow" --body "Closes #138"
```

Если использовать `jj`, то только как личный слой удобства поверх Git. Для
репозитория по-прежнему обязательны Git-совместимые имена веток, обычные
коммиты и тот же issue/PR workflow, который описан в `AGENTS.md`.

## Тесты

```bash
Expand Down
Loading
Loading