Compare commits

...

3 Commits

Author SHA1 Message Date
lachtan
0041ce95dc Commit messages must be in English 2026-03-15 20:41:57 +01:00
lachtan
dd7a9249a2 Update project documentation 2026-03-15 20:36:02 +01:00
lachtan
7ad3fa729c Add forgotten .claude/settings.local.json to .gitignore 2026-03-15 20:35:51 +01:00
3 changed files with 15 additions and 3 deletions

1
.gitignore vendored
View File

@@ -9,3 +9,4 @@
.vscode/
.idea/
.claude/settings.local.json

View File

@@ -10,6 +10,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
- `bin/` — Scripts auto-added to PATH. New CLI tools go here.
- `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config).
- `conf/` — Tool configs (vim, WireGuard, WSL).
- `doc/` — Reference docs, cheatsheets, bookmarks.
- `functions.sh` — Core lib (see below).
## Key Helpers (`functions.sh`)
@@ -26,7 +27,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
## Conventions
All new bash scripts should use:
All new **executable** bash scripts should use:
```bash
#!/usr/bin/env bash
@@ -34,8 +35,13 @@ All new bash scripts should use:
set -E -o errexit -o nounset -o pipefail
```
**Sourced files** (rc files, `functions.sh`) must NOT use `set -o errexit` — they run inside
the user's shell. Add `# shellcheck shell=bash` at the top instead of a shebang.
Before writing shell code, check `functions.sh` for existing helper functions and prefer them over raw commands.
Detailed formatting, naming, and syntax rules are in `.claude/rules/bash-style.md`.
RC files MUST guard slow tools and check availability:
```bash
@@ -53,5 +59,6 @@ Installers (`install/*.sh`) MUST be idempotent — check before installing.
## Commits
Do not add `Co-Authored-By` lines to commit messages.
Prefer one-line commit messages. Add a longer description only when necessary for better understanding.
- Do not add `Co-Authored-By` lines to commit messages.
- Commit messages must be in English.
- Prefer one-line commit messages. Add a longer description only when necessary for better understanding.

View File

@@ -24,6 +24,10 @@ For faster load can be set
For debug log enabled
`LWS_DEBUG=1`
## Directory notes
`opt/` (git-ignored) is used for locally installed tools (e.g. bash-git-prompt, enhancd).
## Quick commands
```bash