Skip to content

docs(readme): fix env var table formatting and conventions links #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drzioner merged 3 commits into from
May 23, 2026
Merged

docs(readme): fix env var table formatting and conventions links #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
549d987
docs(readme): fix env var table formatting and add conventions links
drzioner May 23, 2026
1e73124
docs(readme): fix env var formatting and expose conventions
drzioner May 23, 2026
08ab8b9
docs(conventions): align title level and placeholder style
drzioner May 23, 2026
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
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ CLAUDE.md.bak*
AGENTS.md.bak*
# <<< gitwise managed <<<
.aider.conf.yml
CONVENTIONS.md
8 changes: 8 additions & 0 deletions CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Git conventions

- Diff: `gitwise diff` (= `git diff --name-status HEAD`). Never raw `git diff`.
- Log: `git --no-pager log --oneline -n 20`. Never without a limit.
- Commits: conventional format `feat/fix/refactor/docs/chore: <description>`.
- Commits: always GPG-signed. Never `--no-gpg-sign`.
- Branch switch: `gitwise worktree new <branch>`. Never `git stash + checkout`.
- Before large commits: `gitwise audit --quick`.
6 changes: 4 additions & 2 deletions README.es.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ Para todos los comandos, ejemplos, aliases y uso JSON:
- [Política de seguridad](SECURITY.es.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Código de conducta](CODE_OF_CONDUCT.es.md)
- [Git conventions](CONVENTIONS.md)
- [Convenciones Git](CONVENTIONS.es.md)

## Modelo de seguridad y GPG

Expand All @@ -95,8 +97,8 @@ Para todos los comandos, ejemplos, aliases y uso JSON:
| `GITWISE_DEBUG=1` | Muestra cada comando `git` ejecutado por subprocess en stderr |
| `GITWISE_LOG_JSON=1` | Emite logs estructurados en stderr como líneas JSON |
| `GITWISE_JSON_PRETTY=1` | Formatea JSON en modo pretty por defecto |
| `GITWISE_LANG=es|en` | Fuerza el locale de salida |
| `GITWISE_THEME=dark|light|auto` | Fuerza selección de tema de color |
| `GITWISE_LANG=es` / `GITWISE_LANG=en` | Fuerza el locale de salida |
| `GITWISE_THEME=dark` / `GITWISE_THEME=light` / `GITWISE_THEME=auto` | Fuerza selección de tema de color |
| `GITWISE_NO_COLOR=1` | Desactiva salida ANSI con color |
| `GITWISE_OUTPUT=agent` | Fuerza modo de salida orientado a máquina |
| `GITWISE_AGENT=1` | Alias para habilitar modo agent |
Expand Down
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ For all commands, examples, aliases, and JSON usage, see:
- [Security policy](SECURITY.md)
- [Politica de seguridad](SECURITY.es.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Codigo de conducta](CODE_OF_CONDUCT.es.md)
- [Código de conducta](CODE_OF_CONDUCT.es.md)
- [Git conventions](CONVENTIONS.md)
- [Convenciones Git](CONVENTIONS.es.md)

## GPG and Safety Model

Expand All @@ -92,8 +94,8 @@ For all commands, examples, aliases, and JSON usage, see:
| `GITWISE_DEBUG=1` | Print each `git` subprocess command to stderr |
| `GITWISE_LOG_JSON=1` | Emit structured stderr logs as JSON lines |
| `GITWISE_JSON_PRETTY=1` | Pretty-print JSON output by default |
| `GITWISE_LANG=es|en` | Force output locale |
| `GITWISE_THEME=dark|light|auto` | Override color theme selection |
| `GITWISE_LANG=es` / `GITWISE_LANG=en` | Force output locale |
| `GITWISE_THEME=dark` / `GITWISE_THEME=light` / `GITWISE_THEME=auto` | Override color theme selection |
| `GITWISE_NO_COLOR=1` | Disable ANSI color output |
| `GITWISE_OUTPUT=agent` | Force machine-oriented output mode |
| `GITWISE_AGENT=1` | Alias to enable agent output mode |
Expand Down