Add prose-wrap policy: hard-wrap markdown at 80 columns
Configure prettier with proseWrap: always. Reformat all markdown files to conform.
This commit is contained in:
@@ -1,29 +1,26 @@
|
||||
# Existing Repo Checklist
|
||||
|
||||
Use this checklist when beginning work in a repo that may not yet
|
||||
conform to our
|
||||
Use this checklist when beginning work in a repo that may not yet conform to our
|
||||
[development policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/REPO_POLICIES.md).
|
||||
|
||||
Work on a feature branch. Check each item and fix any gaps before
|
||||
proceeding with your task.
|
||||
Work on a feature branch. Check each item and fix any gaps before proceeding
|
||||
with your task.
|
||||
|
||||
## Required Files
|
||||
|
||||
- [ ] `README.md` exists with all required sections (Description,
|
||||
Getting Started, Rationale, Design, TODO, License, Author)
|
||||
- [ ] `README.md` exists with all required sections (Description, Getting
|
||||
Started, Rationale, Design, TODO, License, Author)
|
||||
- [ ] `LICENSE` file exists and matches the README
|
||||
- [ ] `REPO_POLICIES.md` exists and version date is current with the
|
||||
[authoritative source](https://git.eeqj.de/sneak/prompts/raw/branch/main/REPO_POLICIES.md)
|
||||
- [ ] `.gitignore` is comprehensive (OS, editor, language artifacts,
|
||||
secrets) — fetch from
|
||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore`
|
||||
- [ ] `.gitignore` is comprehensive (OS, editor, language artifacts, secrets) —
|
||||
fetch from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore`
|
||||
if missing
|
||||
- [ ] `.editorconfig` exists
|
||||
- [ ] `Dockerfile` and `.dockerignore` exist
|
||||
- [ ] Language-specific config:
|
||||
- [ ] Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||
- [ ] JS: `package.json`, `yarn.lock`, `.prettierrc`,
|
||||
`.prettierignore`
|
||||
- [ ] JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||
- [ ] Python: `pyproject.toml`
|
||||
- [ ] Docs/writing: `.prettierrc`, `.prettierignore`
|
||||
|
||||
@@ -31,36 +28,32 @@ proceeding with your task.
|
||||
|
||||
- [ ] `Makefile` exists in root — reference the
|
||||
[model Makefile](https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile)
|
||||
- [ ] Has targets: `test`, `lint`, `fmt`, `fmt-check`, `check`,
|
||||
`docker`, `hooks`
|
||||
- [ ] Has targets: `test`, `lint`, `fmt`, `fmt-check`, `check`, `docker`,
|
||||
`hooks`
|
||||
- [ ] `make check` does not modify any files in the repo
|
||||
- [ ] `make test` has a 30-second timeout
|
||||
- [ ] `make check` passes on current branch
|
||||
|
||||
## Formatting
|
||||
|
||||
- [ ] Platform-standard formatter is configured (`black`, `prettier`,
|
||||
`go fmt`)
|
||||
- [ ] Default formatter config, only exception: four-space indents
|
||||
(except Go)
|
||||
- [ ] Platform-standard formatter is configured (`black`, `prettier`, `go fmt`)
|
||||
- [ ] Default formatter config, only exception: four-space indents (except Go)
|
||||
- [ ] All files pass `make fmt-check`
|
||||
|
||||
## Git Hygiene
|
||||
|
||||
- [ ] Pre-commit hook is installed (`make hooks`)
|
||||
- [ ] No secrets in the repo (`.env`, keys, credentials)
|
||||
- [ ] No mutable references in Dockerfiles or scripts (tags,
|
||||
`@latest`) — all pinned by cryptographic hash with version/date
|
||||
comment
|
||||
- [ ] No mutable references in Dockerfiles or scripts (tags, `@latest`) — all
|
||||
pinned by cryptographic hash with version/date comment
|
||||
- [ ] Using `yarn`, not `npm` (JS projects)
|
||||
|
||||
## Directory Structure
|
||||
|
||||
- [ ] No unnecessary files in repo root
|
||||
- [ ] Files organized into canonical subdirectories (`bin/`, `cmd/`,
|
||||
`docs/`, `internal/`, `static/`, etc.)
|
||||
- [ ] Go migrations in `internal/db/migrations/` and embedded in
|
||||
binary
|
||||
- [ ] Files organized into canonical subdirectories (`bin/`, `cmd/`, `docs/`,
|
||||
`internal/`, `static/`, etc.)
|
||||
- [ ] Go migrations in `internal/db/migrations/` and embedded in binary
|
||||
|
||||
## Final
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# New Repo Checklist
|
||||
|
||||
Use this checklist when creating a new repository from scratch. Follow
|
||||
the steps in order. Full policies are at:
|
||||
Use this checklist when creating a new repository from scratch. Follow the steps
|
||||
in order. Full policies are at:
|
||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/REPO_POLICIES.md`
|
||||
|
||||
Template files can be fetched from:
|
||||
@@ -30,11 +30,11 @@ Template files can be fetched from:
|
||||
|
||||
### Fetch Template Files
|
||||
|
||||
- [ ] `.gitignore` — fetch from prompts repo, extend for
|
||||
language-specific artifacts
|
||||
- [ ] `.gitignore` — fetch from prompts repo, extend for language-specific
|
||||
artifacts
|
||||
- [ ] `.editorconfig` — fetch from prompts repo
|
||||
- [ ] `Makefile` — fetch from prompts repo, adapt targets for the
|
||||
project's language and tools
|
||||
- [ ] `Makefile` — fetch from prompts repo, adapt targets for the project's
|
||||
language and tools
|
||||
- [ ] For JS/docs repos: `.prettierrc`, `.prettierignore`
|
||||
|
||||
### Create Project Files
|
||||
@@ -46,8 +46,8 @@ Template files can be fetched from:
|
||||
- Non-server: brings up dev environment and runs `make check`
|
||||
- Image pinned by sha256 hash with version/date comment
|
||||
- [ ] Language-specific:
|
||||
- [ ] Go: `go mod init sneak.berlin/go/<name>`, `.golangci.yml`
|
||||
(copy from `~/dev/upaas/.golangci.yml`)
|
||||
- [ ] Go: `go mod init sneak.berlin/go/<name>`, `.golangci.yml` (copy from
|
||||
`~/dev/upaas/.golangci.yml`)
|
||||
- [ ] JS: `yarn init`, `yarn add --dev prettier`
|
||||
- [ ] Python: `pyproject.toml`
|
||||
|
||||
@@ -57,8 +57,7 @@ Template files can be fetched from:
|
||||
- [ ] `make lint` — runs linter
|
||||
- [ ] `make fmt` — formats code (writes)
|
||||
- [ ] `make fmt-check` — checks formatting (read-only)
|
||||
- [ ] `make check` — prereqs: `test`, `lint`, `fmt-check`; must not
|
||||
modify files
|
||||
- [ ] `make check` — prereqs: `test`, `lint`, `fmt-check`; must not modify files
|
||||
- [ ] `make docker` — builds Docker image
|
||||
- [ ] `make hooks` — installs pre-commit hook
|
||||
|
||||
|
||||
Reference in New Issue
Block a user