Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (51 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 1.91 KB

Contributing to HtmlGraph

HtmlGraph is developed using HtmlGraph itself (dogfooding). .htmlgraph/ contains real work items.

Branch Strategy

main only. All changes go directly to main via pull request.

Setup

git clone https://github.com/shakestzd/htmlgraph.git
cd htmlgraph

# First build (bootstraps from source)
go build -o htmlgraph ./cmd/htmlgraph/

# All subsequent rebuilds
htmlgraph build
# equivalent: plugin/build.sh
# outputs to: plugin/hooks/bin/htmlgraph

Layout

Path Role
cmd/htmlgraph/ CLI entry points
internal/ Business logic
plugin/ Agents, skills, hooks, commands — single source of truth
.htmlgraph/ Work items and session data (generated, not edited directly)

Never edit .claude/ — it is auto-synced from plugin/ and changes are lost.

Dev Mode

htmlgraph claude --dev   # loads plugin from plugin/ via --plugin-dir

Uninstalls the marketplace plugin, clears cache, and launches Claude Code with --plugin-dir plugin/. Reinstalls on exit.

Quality Gates

Run before every commit:

go build ./... && go vet ./... && go test ./...

All three must pass. No exceptions — fix pre-existing errors too.

Making Changes

  1. Create a work item: htmlgraph feature create "title" --track <trk-id> --description "..."
  2. Start it: htmlgraph feature start <feat-id>
  3. Make changes and run quality gates
  4. Complete: htmlgraph feature complete <feat-id>
  5. Push and open a PR to main

Release (Maintainers)

Version lives in plugin/.claude-plugin/plugin.json.

./scripts/deploy-all.sh X.Y.Z --no-confirm

The deploy script updates both the CLI binary and the plugin. Never update one without the other.

Getting Help

License

MIT. Contributions are licensed under the same terms.