Skip to content

docs: add the missing LICENSE, and stop the hero image naming another project - #5

Merged
open-coder-ai merged 2 commits into
mainfrom
docs/license-badges-and-alt-text
Aug 30, 2026
Merged

docs: add the missing LICENSE, and stop the hero image naming another project#5
open-coder-ai merged 2 commits into
mainfrom
docs/license-badges-and-alt-text

Conversation

@open-coder-ai

Copy link
Copy Markdown
Owner

The important one: this repository had no licence

It is public and offered as "a working Chock adoption you can read" — something people are meant to copy from. With no LICENSE file, GitHub and every downstream tool treat a public repository as all rights reserved, so nobody could safely do the one thing the repository exists for.

This adds the org's Apache-2.0 file, byte-identical (md5 78766eae…) to the one already in chock, chock-catalog and the three plugin repositories. No new licensing decision — this repository now says what every sibling already says.

The hero image told crawlers this was chock

The alt text read Chock logo, and .github/logo.svg is chock's mark byte for byte.

Alt text is the only part of an image a crawler, an LLM retriever or a screen reader reads, and it sits in the most prominent slot on the page — so everything reading chock-example was told it was looking at chock. Sharing chock's mark is right for a demo of chock, and the alt now says so; what it could not afford was to name the wrong project and nothing else:

chock-example: a working chock adoption you can read end to end — one policy per artifact layer: git hook, agent rule and skill. The mark is chock's: a wheel held by a chock wedge.

Badge

One licence badge, added now that there is a licence behind it. Nothing else: this repository has no workflows, so a CI or Scorecard badge would be an image of a check that does not run, and the README directs questions and issues to the framework repo, so "PRs welcome" would point people the wrong way.

Same pass applied across the org: chock-quickstart, chock-threat-intel, the three plugin repos, agentseam and chock-catalog.


Generated by Claude Code

… project

Two things a machine reads first, both wrong.

**No LICENSE.** This repository is public and offered as a worked
adoption to read and copy, but with no licence file GitHub and every
downstream tool treat it as all rights reserved. Adds the org's
Apache-2.0 file, byte-identical to the one in chock, chock-catalog and
the plugin repositories.

**The hero image's alt text read "Chock logo".** Alt text is the only
part of an image a crawler, an LLM retriever or a screen reader reads,
and this is the most prominent slot on the page -- so anything reading
chock-example was told it was looking at chock. It now says what this
repository is, then that the mark is chock's.

A licence badge is added now that there is a licence behind it.

Signed-off-by: Claude <noreply@anthropic.com>
The README already says questions and issues belong on the framework
repo, but that sits below the fold and a visitor scans the badge row
first. Someone who opens a pull request here has already wasted their
time by the time they read the prose.

Three badges now, and none of them is the "PRs welcome" every sibling
carries -- this is a sample for developers to copy, not a project to
contribute to:

- Demo repository -> the framework
- License Apache 2.0 -> the LICENSE added in the previous commit
- Issues & PRs -> chock, where they are actually read

The licence is unaffected by that posture and still belongs here: it
governs what someone may do with this sample, not whether they may send
a patch back. Without it nobody could act on "Use this template" at all.

Signed-off-by: Claude <noreply@anthropic.com>
@open-coder-ai
open-coder-ai marked this pull request as ready for review August 30, 2026 14:46
@open-coder-ai
open-coder-ai merged commit 218e9a4 into main Aug 30, 2026
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.

2 participants