8000 docs: add CONTRIBUTING with DCO sign-off (Apache-2.0) by simon-inkie · Pull Request #45 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content

docs: add CONTRIBUTING with DCO sign-off (Apache-2.0) - #45

Merged
simon-inkie merged 1 commit into
mainfrom
docs/contributing-dco
Oct 3, 2026
Merged

simon-inkie merged 1 commit into
mainfrom
docs/contributing-dco

Conversation

@simon-inkie
Copy link
Copy Markdown
Owner

Adds CONTRIBUTING.md: how to contribute, the Developer Certificate of Origin sign-off (git commit -s), and the Apache-2.0 licence terms for contributions.

Docs only. Review: repo leak and hygiene gates run clean locally; Io read the full text. No code changes, so the two-leg code review does not apply.

🤖 Generated with Claude Code

https://claude.ai/code/session_018uNaFhmK6yxSR7XfzJDY3Z

Setup, required checks, branch and PR conventions, and a Developer
Certificate of Origin section. No CLA.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018uNaFhmK6yxSR7XfzJDY3Z
Signed-off-by: Simon <simon@inkie.ink>
@simon-inkie
Copy link
Copy Markdown
Owner Author

Review, Sonnet, 2026-10-02

PR 45 (CONTRIBUTING.md with DCO sign-off, docs only). SHA reviewed: 4aab6eb

Verdict: PASS with notes (0 Major)

Docs only, nothing to run. I checked its claims against the tree. Verified: the root dev, build, start scripts forward to packages/deck; check:boundaries, check:leaks (plus :history, :messages), check:licence, check:lib-version exist in the root package.json; check:dashes exists in packages/deck; Node range and packageManager match; LICENSE is present. Hygiene: no internal names, paths, hostnames, secrets or commercial mentions; no em or en dashes.

Critical

None.

Major

None.

Minor

  1. "CI runs these" is not accurate for every command listed. .github/workflows/ci.yml runs typecheck, test, boundaries, the leak gate (tree scope only), lib-version, licence and gitleaks. It does not run check:dashes as a step (it is covered only indirectly if the dashes test inspects the tree; the one I found tests the script against fixtures), nor check:leaks:history or :messages. Fix: reword to "CI runs most of these; run all of them locally", or add the missing steps to CI.

  2. The DCO is stated as a requirement ("every commit must carry a Signed-off-by:") but nothing enforces it, and there is no CI check. Fix: add the DCO GitHub App or a small CI step, or soften to "please sign off". Without enforcement, maintainers will end up asking by hand.

  3. Security reporting path may not exist. The doc sends people to the Security tab's "Report a vulnerability". gh api repos/simon-inkie/inkie-deck/private-vulnerability-reporting returned 404 for me, and there is no SECURITY.md. A 404 can also mean my token lacks admin rights, so I could not tell whether it is enabled. Fix: confirm the setting is on before merge (Settings, Code security), or add a SECURITY.md with a contact address.

  4. The SPEC convention (.specs/<issue>-<slug>/SPEC.md) points contributors at a directory that does not exist in the tree (no tracked .specs files). Fix: say "for non-trivial work, include a short design note in the PR description" or add an example, since outside contributors cannot see prior specs.

  5. The commit trailers on this commit include a Claude-Session: URL and a Co-Authored-By line. Not part of the file, but the commit message is public history in a repo that has check:leaks:messages; confirm that gate is happy with a session URL, and decide whether such trailers belong in public history at all. The same trailers are on PRs 46, 47 and 48.

Nit

  1. The DCO text is reproduced in full; fine, but link-only would keep the file shorter. Keep it if you want it self-contained.
  2. "Two suites report the state of the tree, not of your change" does not name the two suites; name them so a contributor can recognise the failure.
  3. git rebase --signoff main rewrites commits and needs a force push; say "force-push your own branch" for first-time contributors.

Not checked

  • Whether the DCO text matches the canonical 1.1 text byte for byte (it reads right, I did not diff it).
  • That pnpm dev really reseeds a throwaway inbox under .runtime/ as described.
  • Rendering on GitHub, and links.

@simon-inkie
simon-inkie merged commit 9201da1 into main Oct 3, 2026
4 checks passed
simon-inkie pushed a commit that referenced this pull request Oct 4, 2026
…f commits

Rebased onto main, which now carries CONTRIBUTING.md (from #45). AGENTS.md
and CLAUDE.md are pointers to CONTRIBUTING.md and DEVELOPMENT.md rather than
a second rulebook: the branch-naming, issue-first and DCO rules are stated in
one place only. DEVELOPMENT.md and the start-issue skill now sign off every
commit (git commit -s) and the skill's first commit uses the
type(scope): summary (#issue) style. The SPEC rule is scoped to non-trivial
work, matching CONTRIBUTING.md.

Refs #39

Signed-off-by: Simon <simon@inkie.ink>
simon-inkie pushed a commit that referenced this pull request Oct 4, 2026
…f commits (#39)

Rebased onto main, which now carries CONTRIBUTING.md (from #45). AGENTS.md
and CLAUDE.md are pointers to CONTRIBUTING.md and DEVELOPMENT.md rather than
a second rulebook: the branch-naming, issue-first and DCO rules are stated in
one place only. DEVELOPMENT.md and the start-issue skill now sign off every
commit (git commit -s) and the skill's first commit uses the
type(scope): summary (#issue) style. The SPEC rule is scoped to non-trivial
work, matching CONTRIBUTING.md.

Refs #39

Signed-off-by: Simon <s
8000
imon@inkie.ink>
simon-inkie added a commit that referenced this pull request Oct 4, 2026
…sue skill (#40)

* docs: start issue 39 with the SPEC skeleton (#39)

Signed-off-by: Simon <simon@inkie.ink>

* docs(contrib): align the agent workflow with CONTRIBUTING and sign off commits (#39)

Rebased onto main, which now carries CONTRIBUTING.md (from #45). AGENTS.md
and CLAUDE.md are pointers to CONTRIBUTING.md and DEVELOPMENT.md rather than
a second rulebook: the branch-naming, issue-first and DCO rules are stated in
one place only. DEVELOPMENT.md and the start-issue skill now sign off every
commit (git commit -s) and the skill's first commit uses the
type(scope): summary (#issue) style. The SPEC rule is scoped to non-trivial
work, matching CONTRIBUTING.md.

Refs #39

Signed-off-by: Simon <simon@inkie.ink>

---------

Signed-off-by: Simon <simon@inkie.ink>
Co-authored-by: Simon <simon@inkie.ink>
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

0