sneak/prompts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add missing policies and required files

Browse Source 
- Never use git add -A; always stage files by name
- Makefile must provide make hooks target for pre-commit setup
- All repos should have .editorconfig
- JS required files: yarn.lock, .prettierrc, .prettierignore
- Python required files: pyproject.toml
This commit is contained in:
Jeffrey Paul 2026-02-22 15:51:59 +01:00
parent aaae9714da
commit 16afdb8113
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
REPO_POLICIES.md
View File

@ -22,7 +22,8 @@
exception: set four-space indents for everything except Go. exception: set four-space indents for everything except Go.
- Pre-commit hook: `make check` if local testing is possible, otherwise - Pre-commit hook: `make check` if local testing is possible, otherwise
`make lint && make fmt-check`. `make lint && make fmt-check`. The Makefile should provide a
`make hooks` target to install the pre-commit hook.
- `make test` must complete in under 20 seconds. Add a 30-second timeout - `make test` must complete in under 20 seconds. Add a 30-second timeout
in the Makefile. in the Makefile.
@ -34,6 +35,9 @@
- `main` must always pass `make check`, no exceptions. - `main` must always pass `make check`, no exceptions.
- Never use `git add -A` or `git add .`. Always stage files explicitly
by name.
- Make all changes on a feature branch. You can do whatever you want on - Make all changes on a feature branch. You can do whatever you want on
a feature branch. a feature branch.
@ -79,9 +83,13 @@
- Pre-1.0.0: modify existing migrations (no installed base assumed). - Pre-1.0.0: modify existing migrations (no installed base assumed).
Post-1.0.0: add new migration files. Post-1.0.0: add new migration files.
- All repos should have an `.editorconfig` enforcing the project's
indentation settings.
- New repos must contain at minimum: - New repos must contain at minimum:
- `README.md`, `.git`, `.gitignore` - `README.md`, `.git`, `.gitignore`, `.editorconfig`
- `REPO_POLICIES.md` (copy from the `prompts` repo) - `REPO_POLICIES.md` (copy from the `prompts` repo)
- `Dockerfile`, `.dockerignore` - `Dockerfile`, `.dockerignore`
- Go: `go.mod`, `go.sum`, `.golangci.yml` - Go: `go.mod`, `go.sum`, `.golangci.yml`
- JS: `package.json` - JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
- Python: `pyproject.toml`