Check off completed repo policy compliance items in TODO.md
This commit is contained in:
37
TODO.md
37
TODO.md
@@ -14,18 +14,18 @@
|
|||||||
|
|
||||||
# Next Step
|
# Next Step
|
||||||
|
|
||||||
- bring the repo into full policy compliance (work the Repo Policy
|
- add a remote on git.eeqj.de and push (`main` plus tags)
|
||||||
Compliance checklist below)
|
|
||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- bring the repo into full policy compliance (2026-07-23, branch
|
||||||
|
`repo-policy-compliance`; checklist below)
|
||||||
- `git init` with README-only first commit; code baseline committed on
|
- `git init` with README-only first commit; code baseline committed on
|
||||||
`main` (2026-07-22)
|
`main` (2026-07-22)
|
||||||
- implement `scan`, `report`, and `trees` subcommands (pre-git history)
|
- implement `scan`, `report`, and `trees` subcommands (pre-git history)
|
||||||
|
|
||||||
# Future Steps
|
# Future Steps
|
||||||
|
|
||||||
- add a remote on git.eeqj.de and push (`main` plus tags)
|
|
||||||
- convert Makefile targets to scripts-to-rule-them-all `script/`
|
- convert Makefile targets to scripts-to-rule-them-all `script/`
|
||||||
entrypoints like the other managed repos
|
entrypoints like the other managed repos
|
||||||
- tag `v0.0.1` once the compliance branch is merged
|
- tag `v0.0.1` once the compliance branch is merged
|
||||||
@@ -38,33 +38,34 @@ Audited 2026-07-22 against `REPO_POLICIES.md` (2026-07-06), the existing
|
|||||||
repo checklist, and the Go styleguide. Code is already gofmt-clean, so no
|
repo checklist, and the Go styleguide. Code is already gofmt-clean, so no
|
||||||
standalone formatting commit is needed.
|
standalone formatting commit is needed.
|
||||||
|
|
||||||
- [ ] `.gitignore` missing — the compiled `sfdupes` binary and
|
- [x] `.gitignore` missing — the compiled `sfdupes` binary and
|
||||||
`files.dat` sit untracked in the tree; needs OS/editor/Go
|
`files.dat` sit untracked in the tree; needs OS/editor/Go
|
||||||
artifacts plus secrets patterns
|
artifacts plus secrets patterns
|
||||||
- [ ] `.editorconfig` missing
|
- [x] `.editorconfig` missing
|
||||||
- [ ] `LICENSE` missing and README has no License section (MIT assumed
|
- [x] `LICENSE` missing and README has no License section (MIT assumed
|
||||||
from house convention — user to confirm)
|
from house convention — user to confirm)
|
||||||
- [ ] `REPO_POLICIES.md` missing from repo root
|
- [x] `REPO_POLICIES.md` missing from repo root
|
||||||
- [ ] `.golangci.yml` missing (install canonical copy); code must then
|
- [x] `.golangci.yml` missing (install canonical copy); code must then
|
||||||
pass `make lint`
|
pass `make lint` (150 findings fixed; `make lint` is clean)
|
||||||
- [ ] `Makefile` lacks required targets `test`, `lint`, `fmt`,
|
- [x] `Makefile` lacks required targets `test`, `lint`, `fmt`,
|
||||||
`fmt-check`, `docker`, `hooks`; `check` currently depends on
|
`fmt-check`, `docker`, `hooks`; `check` currently depends on
|
||||||
`build`, which writes the binary (`make check` must not modify
|
`build`, which writes the binary (`make check` must not modify
|
||||||
files)
|
files)
|
||||||
- [ ] no tests — `go test ./...` has nothing to run; policy requires
|
- [x] no tests — `go test ./...` has nothing to run; policy requires
|
||||||
real tests with a 30-second timeout and the conditional `-v`
|
real tests with a 30-second timeout and the conditional `-v`
|
||||||
rerun pattern
|
rerun pattern (suite covers parsing, grouping, digests,
|
||||||
- [ ] `Dockerfile` missing — Go multistage with hash-pinned images:
|
suppression, hashing, and the scan pipeline; 64% coverage)
|
||||||
|
- [x] `Dockerfile` missing — Go multistage with hash-pinned images:
|
||||||
fail-fast lint stage, build stage running `make check`
|
fail-fast lint stage, build stage running `make check`
|
||||||
- [ ] `.dockerignore` missing
|
- [x] `.dockerignore` missing
|
||||||
- [ ] `.gitea/workflows/check.yml` missing (`docker build .` on push,
|
- [x] `.gitea/workflows/check.yml` missing (`docker build .` on push,
|
||||||
checkout action pinned by commit SHA)
|
checkout action pinned by commit SHA)
|
||||||
- [ ] README lacks required sections: Description first line
|
- [x] README lacks required sections: Description first line
|
||||||
(name/purpose/category/license/author), Getting Started,
|
(name/purpose/category/license/author), Getting Started,
|
||||||
Rationale, TODO, License, Author
|
Rationale, TODO, License, Author
|
||||||
- [ ] README non-goal "no git repository setup and no CI" is stale now
|
- [x] README non-goal "no git repository setup and no CI" is stale now
|
||||||
that the repo is under git with CI
|
that the repo is under git with CI
|
||||||
- [ ] pre-commit hook not installed (`make hooks` once the target
|
- [x] pre-commit hook not installed (`make hooks` once the target
|
||||||
exists)
|
exists)
|
||||||
|
|
||||||
Accepted divergences (no action):
|
Accepted divergences (no action):
|
||||||
|
|||||||
Reference in New Issue
Block a user