sneak
03bf0b8445
All checks were successful
check / check (push) Successful in 7s
- Add .golangci.yml from upaas as authoritative copy in this repo - Update REPO_POLICIES.md to reference .golangci.yml by URL - Add fetch URLs for all template files in both checklists: .gitignore, .editorconfig, Makefile, .prettierrc, .prettierignore, REPO_POLICIES.md, .golangci.yml, check.yml
3.4 KiB
3.4 KiB
Existing Repo Checklist
Use this checklist when beginning work in a repo that may not yet conform to our repository policies.
Work on a feature branch. Check each item and fix any gaps before proceeding with your task.
Formatting (do this first)
- If the repo has never been formatted to our standards, run
make fmtand commit the result as a standalone branch/commit/PR before any other changes. Formatting diffs can be large and should not be mixed with functional changes.
Required Files
README.mdexists with all required sections (Description, Getting Started, Rationale, Design, TODO, License, Author)LICENSEfile exists and matches the READMEREPO_POLICIES.mdexists and version date is current with the authoritative source.gitignoreis comprehensive (OS, editor, language artifacts, secrets) — fetch fromhttps://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignoreif missing.editorconfigexistsDockerfileand.dockerignoreexist; Dockerfile runsmake checkas a build step- Gitea Actions workflow in
.gitea/workflows/runsdocker build .on push — reference check.yml - Language-specific config:
- Go:
go.mod,go.sum,.golangci.yml - JS:
package.json,yarn.lock,.prettierrc,.prettierignore - Python:
pyproject.toml - Docs/writing:
.prettierrc,.prettierignore
- Go:
Makefile
Makefileexists in root — reference the model Makefile- Has targets:
test,lint,fmt,fmt-check,check,docker,hooks make checkdoes not modify any files in the repomake testhas a 30-second timeoutmake checkpasses on current branch
Formatting
- 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 - Using
yarn, notnpm(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
Final
make checkpassesdocker buildsucceeds- Commit and merge fixes before starting your actual task