Skip to content

docs(cli): examples + CHANGELOG + CONTRIBUTING#1

Merged
sirambrosio merged 1 commit into
mainfrom
docs/cli-polish
Apr 20, 2026
Merged

docs(cli): examples + CHANGELOG + CONTRIBUTING#1
sirambrosio merged 1 commit into
mainfrom
docs/cli-polish

Conversation

@sirambrosio
Copy link
Copy Markdown
Contributor

Summary

DX polish — three complementary pieces making bspctl easier to adopt, contribute to, and version.

  • `examples/` — runnable bash scripts for the three core flows (create BEO, grant consent, submit BioRecord). Each script includes argument validation, inline docs, and next-step hints.
  • `CHANGELOG.md` — Keep a Changelog format, SemVer, covers 0.1.0 -> 0.2.0 history plus [Unreleased] section.
  • `CONTRIBUTING.md` — dev setup, PR checklist, coding style, conventional commits, security rules around private keys, release process.
  • `README.md` — expanded "Command Reference - Detailed" section covering all 22 commands with every flag (required / optional / default) and example invocations.

Test plan

  • `bash examples/create-beo.sh alice-test.bsp` walks through creation on testnet
  • `bash examples/grant-consent.sh ` issues a token with default scope
  • `bash examples/submit-biorecord.sh fixtures/sample.json` submits successfully
  • All internal README links resolve
  • Link to `bsp-spec/docs/ERROR_CODES.md` resolves once that PR merges

🤖 Generated with Claude Code

- examples/: runnable bash scripts for three core flows
  - create-beo.sh: bootstrap a sovereign biological identity
  - grant-consent.sh: issue a scoped ConsentToken to an IEO
  - submit-biorecord.sh: submit measurements with consent verification
- CHANGELOG.md: Keep a Changelog format, SemVer, covers 0.1.0 -> 0.2.0 plus
  [Unreleased] entry for this doc polish
- CONTRIBUTING.md: dev setup, PR checklist, coding style, conventional
  commits, security policy, release process
- README.md: expanded "Command Reference - Detailed" section with full
  flag documentation + example for each of the 22 commands. Link to
  examples/ and CHANGELOG.md.
@sirambrosio sirambrosio merged commit 789cec5 into main Apr 20, 2026
3 checks passed
@sirambrosio sirambrosio deleted the docs/cli-polish branch April 20, 2026 14:41
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