Skip to content

Contributing

Jump to bottom
Kritarth-Dandapat edited this page Jul 19, 2026 · 1 revision

Contributing

Repository layout

/wrangler.toml.example   Worker config template — copy to wrangler.toml (git-ignored)
/src/index.js             Edge gateway: upload + render logic
/cli/                     dkraft-publish CLI, published as freeflow-dkraft-publisher on npm
/templates/               Example HTML templates (e.g. plan-template.html)
/.claude/skills/freeflow-publish/  Agent skill teaching the publish workflow
/docs/                    Source for the GitHub Pages site

Making changes

  • Worker (src/index.js) — single file, no bundler. Test locally with npm run worker:dev, deploy with npm run worker:deploy.
  • CLI (cli/) — its own package.json, published independently to npm as freeflow-dkraft-publisher.

Branch protection

master has force-push and deletion blocked. No required status checks yet (no CI workflow configured) and no mandatory PR reviews — direct pushes are allowed for maintainers. If CI is added later, wire required status checks into the branch protection rule.

Pull requests

No formal template yet. Keep changes scoped — the Worker and CLI are small, single-purpose files; prefer minimal diffs over refactors bundled with features.

Coding agents

This repo is built to be agent-friendly:

  • .claude/skills/freeflow-publish/SKILL.md is a plain-language runbook any coding agent can follow to publish drafts through the CLI.
  • GitHub Copilot coding agent, Anthropic code agent, and OpenAI code agent are all available as issue assignees on this repo (see suggested assignees on any issue).

Reporting issues

Use GitHub Issues. For security-relevant gaps, see Security for the current known-issues list before filing a duplicate.

Clone this wiki locally