Files

check / check (push) Successful in 7s

Details

Add test requirements to checklists, .dockerignore URLs, root symlink, and Makefile comment

- Add test requirement item to both checklists (must not be a no-op)
- Add .dockerignore template URL to Dockerfile items in both checklists
- Add REPO_POLICIES.md symlink in repo root pointing to prompts/
- Add comment to Makefile explaining why prettier flags are repeated

2026-02-22 17:21:42 +01:00

3.4 KiB

Raw Blame History

title, last_modified

title	last_modified
New Repo Checklist	2026-02-22

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/prompts/REPO_POLICIES.md.

Template files can be fetched from: https://git.eeqj.de/sneak/prompts/raw/branch/main/<path>

1. Initialize

git init
Ask the user for the license (MIT, GPL, or WTFPL)

2. First Commit (README only)

Create README.md with all required sections:
- Description: name, purpose, category, license, author
- Getting Started: copy-pasteable code block
- Rationale: why does this exist?
- Design: how is it structured?
- TODO: initial task list
- License: matches chosen license
- Author: @sneak
git add README.md && git commit

3. Scaffolding (feature branch)

git checkout -b initial-scaffolding

Fetch Template Files

.gitignore — fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore, extend for language-specific artifacts
.editorconfig — fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig
Makefile — fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile, adapt targets for the project's language and tools
For JS/docs repos: .prettierrc and .prettierignore — fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/.prettierrc and https://git.eeqj.de/sneak/prompts/raw/branch/main/.prettierignore

Create Project Files

LICENSE file matching the chosen license
REPO_POLICIES.md — fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md
Dockerfile and .dockerignore — fetch .dockerignore from https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore
- All Dockerfiles must run make check as a build step
- Server: also builds and runs the application
- Non-server: brings up dev environment and runs make check
- Image pinned by sha256 hash with version/date comment
Gitea Actions workflow at .gitea/workflows/check.yml that runs docker build . on push — reference https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml
Language-specific:
- Go: go mod init sneak.berlin/go/<name>, .golangci.yml (fetch from https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml)
- JS: yarn init, yarn add --dev prettier
- Python: pyproject.toml

Configure Makefile

make test — runs real tests, not a no-op (30-second timeout)
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 docker — builds Docker image
make hooks — installs pre-commit hook

4. Verify

make check passes
make docker succeeds
No secrets in repo
No mutable image/package references
No unnecessary files in repo root
All dates written as YYYY-MM-DD

5. Merge and Set Up

Commit, merge to main
make hooks to install pre-commit hook
Add remote and push
Verify main passes make check

3.4 KiB Raw Blame History