Skip to content

docs: acknowledgements, AI-attribution policy, badge fix - #3

Merged
REPPL merged 1 commit into
mainfrom
docs/acknowledgements-attribution
Jul 7, 2026
Merged

docs: acknowledgements, AI-attribution policy, badge fix#3
REPPL merged 1 commit into
mainfrom
docs/acknowledgements-attribution

Conversation

@REPPL

@REPPL REPPL commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Establishes how abcd credits contributions, and fixes repo presentation while private.

ACKNOWLEDGEMENTS.md (new)

Three sections, matching the split you asked for and refining the public abcd file's two-way scheme:

  • Development — AI assistance now; human contributors + integrated tools as they land.
  • Inspirations — ideas/methodologies that shaped the design (Working Backwards, MADR, Diátaxis, DDD, the kernel Assisted-by: policy).
  • References & sources — books/articles/papers (Evans 2003, EARS 2009, Copyright Office 2025).

Anti-staleness: the procedure binds each entry to the change that lands it (adopt a pattern / cite a source in an ADR / integrate a tool → add the entry in that same PR), so it is never reconstructed after the fact. A deterministic cross-check (record-lint: cited sources must appear here) is a candidate follow-up.

AI-attribution policy (AGENTS.md, CONTRIBUTING.md)

Kernel-style Assisted-by: Claude:claude-opus-4-8 trailer — disclosure, not authorship; never Co-Authored-By: for AI. Human is author of record; human-only DCO deferred to the public flip. This PR's own commit dogfoods the trailer. Naming a tool is confined to attribution; user-facing prose stays host-agnostic (the harness/* rules still enforce it — the Built-with-Claude-Code badge uses the <!-- docs-lint: allow --> escape).

Badges

Removed the two dynamic github/* badges that can't read a private repo (release, last-commit); kept a static set (license-MIT, status, Go); added Built with Claude Code (your itemdeck pattern). A comment marks re-adding dynamic badges at the flip.

.mailmap

Folds a stray unset-identity commit and a second display name into one canonical author — display-only, no history rewrite (compatible with the force-push block).

Verification: docs-lint / record-lint / gofmt / build / test all green; staged diff has zero private-name hits.

Filename is plural (ACKNOWLEDGEMENTS.md) to match the public abcd repo; the global convention + root-docs allowlist were updated to match.

Establish how abcd credits contributions and present the repo honestly while
private.

- ACKNOWLEDGEMENTS.md (new): three sections — development (AI assistance now;
  human contributors + integrated tools as they land), inspirations (ideas that
  shaped the design), references (books/articles/papers). Entries are added in the
  change that lands them, so the file never goes stale.
- AI-attribution policy (AGENTS.md, CONTRIBUTING.md): AI-assisted commits carry a
  kernel-style `Assisted-by:` trailer — disclosure, not authorship; never
  `Co-Authored-By:` for AI. Human is author of record; DCO deferred to the public
  flip. Naming a tool is confined to attribution/acknowledgement; user-facing prose
  stays host-agnostic.
- README badges: drop the dynamic github/* badges that cannot read a private repo
  (release, last-commit), keep a static set (license, status, Go), add a
  Built-with-Claude-Code badge behind the docs-lint allow escape. Dynamic badges
  return at the public flip.
- docs-lint: allow ACKNOWLEDGEMENTS at the repo root.
- .mailmap: consolidate author identities for display (folds a stray unset-identity
  commit and a second display name into one), without rewriting history.

Assisted-by: Claude:claude-opus-4-8
@REPPL
REPPL merged commit ea420a1 into main Jul 7, 2026
11 checks passed
@REPPL
REPPL deleted the docs/acknowledgements-attribution branch July 7, 2026 12:05
REPPL added a commit that referenced this pull request Jul 11, 2026
Establish how abcd credits contributions and present the repo honestly while
private.

- ACKNOWLEDGEMENTS.md (new): three sections — development (AI assistance now;
  human contributors + integrated tools as they land), inspirations (ideas that
  shaped the design), references (books/articles/papers). Entries are added in the
  change that lands them, so the file never goes stale.
- AI-attribution policy (AGENTS.md, CONTRIBUTING.md): AI-assisted commits carry a
  kernel-style `Assisted-by:` trailer — disclosure, not authorship; never
  `Co-Authored-By:` for AI. Human is author of record; DCO deferred to the public
  flip. Naming a tool is confined to attribution/acknowledgement; user-facing prose
  stays host-agnostic.
- README badges: drop the dynamic github/* badges that cannot read a private repo
  (release, last-commit), keep a static set (license, status, Go), add a
  Built-with-Claude-Code badge behind the docs-lint allow escape. Dynamic badges
  return at the public flip.
- docs-lint: allow ACKNOWLEDGEMENTS at the repo root.
- .mailmap: consolidate author identities for display (folds a stray unset-identity
  commit and a second display name into one), without rewriting history.

Assisted-by: Claude:claude-opus-4-8
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