Skip to content

SliceOps/quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SliceOps Quickstart — Day 1

A minimal, clonable repository that already runs on the SliceOps framework (spec v1.1.0). Not a tutorial about the framework — a working corpus you extend. In ~30 minutes you ship one slice through the real loop:

slice  →  decision (DEC)  →  code + tests  →  evidence.v1 record  →  merge

with the real gates running in CI: the toolkit consistency validators (including schema validation of every evidence record), the test suite, and a secrets scan.

What's already here (10 minutes — read in this order)

Artifact File What it shows
The adoption decision 10-decisions/accepted/DEC-001-adopt-sliceops.md A ratified DecisionRecord: frontmatter schema, lifecycle, explicit approver (P3)
The slice ledger 70-execution/slice-tracker.md One row per slice; BL-01.SL-002 is reserved for you
The evidence record evidence/sl-001-adopt-sliceops.evidence.json A valid evidence.v1 record: all P6 categories + the P7 security gate, hash-anchored to src/hello.py, pointing at the work commit
The gate .github/workflows/ci.yml CI fails if the corpus drifts: DEC schema, status enum, approver rule, evidence schema, tests, secrets
The product src/hello.py + tests/ Deliberately tiny — the audit plane is the subject here

Verify the evidence yourself (third-party verification is the point):

# the artifact hash in the evidence record is recomputable
shasum -a 256 src/hello.py
# the record validates against the canonical schema at its $id
pip install jsonschema check-jsonschema 2>/dev/null || pip install jsonschema
python3 -c "
import json, urllib.request, jsonschema
schema = json.load(urllib.request.urlopen('https://sliceops.org/schemas/evidence/evidence.v1.schema.json'))
record = json.load(open('evidence/sl-001-adopt-sliceops.evidence.json'))
jsonschema.Draft202012Validator(schema).validate(record)
print('valid evidence.v1 record')
"

Your first slice (20 minutes)

Use this repo as a template (button above) or clone it, then:

  1. Claim the slice. In 70-execution/slice-tracker.md, fill the BL-01.SL-002 row: today's date, your scope (suggestion: add a farewell(name) function), status note.
  2. Write the decision first. Copy DEC-001's frontmatter into 10-decisions/accepted/DEC-002-<your-slug>.md. Set status: proposed, originating_slice: BL-01.SL-002, and write TL;DR / Context / Decision / Consequences in a few lines each. Decision-first: the DEC exists before the code.
  3. Ship the change. Implement it in src/, add a test in tests/, and run python3 -m unittest discover -s tests from the repo root until green.
  4. Ratify. Flip the DEC to status: ratified and record approver: — your handle. Single-maintainer self-ratification is fine because it is recorded (P3, spec v1.1.0); with two maintainers, approver must differ from owner.
  5. Emit the evidence. Copy evidence/sl-001-adopt-sliceops.evidence.json to evidence/sl-002-<your-slug>.evidence.json and update: evidenceId, the check results you actually ran, decisionRefs: ["DEC-002"], provenance.sliceId: "BL-01.SL-002", provenance.commitSha = the SHA of your work commit (git rev-parse --short=40 HEAD after committing the work, then commit the record — evidence points at the work it evidences), and the artifacts[].hash = shasum -a 256 of the file you touched.
  6. Open the PR. CI runs the whole gate. If your DEC is missing a field, its status is off-enum, a ratified DEC lacks an approver, or your evidence record doesn't validate — the build fails. That is the framework working.

What the gate enforces

  • Consistency validators (fetched from the toolkit, all checks): DEC frontmatter schema incl. the Layer-1 fields and the approver rule for DECs ratified from 2026-07-03, status lifecycle enum, cross-reference symmetry, count coherence, CI cost hygiene, and evidence-schema: every evidence/*.evidence.json validated against the canonical evidence.v1 schema (a slice-merge record must carry functional, quality and security checks, a decision ref, and slice + commit provenance — the schema enforces it, not convention).
  • Unit tests — the functional evidence your record attests to.
  • gitleaks — the P7 secrets gate (secrets never enter code or evidence).

The topic-tags check reports SKIPPED here (this corpus defines no topic taxonomy yet) — visible, documented, not hidden.

Where to go next

License

MIT (see LICENSE). The SliceOps spec itself is CC BY 4.0 + MIT — see sliceops.org/license.

About

Day 1 SliceOps — a clonable minimal corpus: slice → decision → evidence → merge in 30 minutes, with the real gates in CI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages