Skip to content

docs(readiness): document package use - #6

Open
systemfsoftware-maker wants to merge 1 commit into
mainfrom
sys-1136-readme-publication
Open

systemfsoftware-maker wants to merge 1 commit into
mainfrom
sys-1136-readme-publication

Conversation

@systemfsoftware-maker

Copy link
Copy Markdown
Contributor

Part of SYS-1136 (partial)

Summary

Adds a consumer README, contributor setup and Apache-2.0 license. The starter, agent and subtree setup remains unfinished; this PR does not include the protected hook configuration.

README process and evidence

The write-readme-md library and structure guidance was used to prepare the README. The committed README was scored, read, and checked against its install and usage evidence. The regenerated score is 4/13, with an empty triage finding list. The skill sets no score threshold; its holdout means are 4.69/13 for trending READMEs and 3.74/13 for matched non-trending READMEs.

The README and license bytes match the retained source. The contributor guide removes the statement about repos/ subtrees because that setup is not in this branch.

In a clean checkout, the committed README's npm 1.0.0 install and usage were run through the pinned sandbox. Installation added 18 packages and reported 0 vulnerabilities; the example printed Satisfied. Both commands exited 0. The source package is at 1.1.2, which was not published to npm when checked. No package was published by this change.

Checks and pending evidence

The simplification preflight found documentation and license text only; it made no changes and reran no checks. README byte equality and license byte equality were checked with cmp; the contributor diff was inspected. No full pnpm check:local pass is claimed. That repository-required command remains pending off-host before merge, alongside independent review and required CI. The actual CI command and result must be recorded when available; an affected-only lane does not establish that pnpm check:local ran.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant