Establish ConfigKit module and extraction baseline
This commit is contained in:
@@ -1,9 +1,10 @@
|
||||
# Development
|
||||
|
||||
This is the contributor entry point for ConfigKit. Read the task-specific owners
|
||||
below before making changes. The repository is in pre-implementation: it has no
|
||||
Go module, packages, tests, or executable examples yet. The
|
||||
[component overview](internal/overview.md) owns the implementation inventory.
|
||||
below before making changes. The repository is in early implementation: it has a
|
||||
Go module and documented root package, but no loading behavior or executable
|
||||
examples yet. The [component overview](internal/overview.md) owns the implementation
|
||||
inventory.
|
||||
|
||||
## Initial orientation
|
||||
|
||||
@@ -34,25 +35,34 @@ Accepted decisions:
|
||||
|
||||
For cross-cutting changes, follow every applicable row. The
|
||||
[implementation plan](roadmap/implementation.md) owns the ordered stages and their
|
||||
acceptance checks; all remain pending until implementation evidence is recorded.
|
||||
acceptance checks and recorded implementation evidence.
|
||||
|
||||
## Baseline validation
|
||||
|
||||
For the current documentation-only repository:
|
||||
Install Go 1.25.0 or a supported patched/newer Go toolchain. Acquire declared
|
||||
dependencies explicitly before entering an offline development or validation
|
||||
environment:
|
||||
|
||||
```sh
|
||||
go mod download
|
||||
```
|
||||
|
||||
Run the library baseline from the repository root:
|
||||
|
||||
```sh
|
||||
go test ./...
|
||||
go vet ./...
|
||||
go build ./...
|
||||
git diff --check
|
||||
```
|
||||
|
||||
Also inspect new untracked documents, verify changed local links and heading
|
||||
fragments, and review paths, examples, ownership, and current-versus-planned
|
||||
claims. The command above does not check links or untracked content.
|
||||
|
||||
Go validation is not runnable until a module and packages exist. The scaffolding
|
||||
change must establish and verify library test, vet, and build commands here,
|
||||
including their prerequisites. Do not use an application binary build as the
|
||||
library baseline. Add executable-example and other checks when those artifacts
|
||||
are introduced; do not document nonexistent tools as operational.
|
||||
The default tests must remain deterministic and runnable without network access or
|
||||
credentials after dependency acquisition. Also inspect new untracked files, verify
|
||||
changed local links and heading fragments, and review paths, examples, ownership,
|
||||
and current-versus-planned claims. The commands above do not check links or
|
||||
untracked content. Do not use an application binary build as the library baseline.
|
||||
Add executable-example and other checks when those artifacts are introduced; do
|
||||
not document nonexistent tools as operational.
|
||||
|
||||
Once code exists, use focused checks while iterating and validation proportionate
|
||||
to the change under the testing policy. Documentation-only work does not require
|
||||
|
||||
Reference in New Issue
Block a user