docs: add CONTRIBUTING, CLA, CoC, CONTRIBUTORS and CLA workflows (#18)#27
Merged
Merged
Conversation
Phase 5 Part 2 — governance documentation and CI automation:
* CONTRIBUTING.md — branching, commits, test requirements,
agent-gate stack (per-commit / per-issue split), performance
baseline, release discipline, security reporting. British
English throughout.
* CLA.md — AxonOps contributor licence agreement, adapted from
the axonops/mask template with project-name substitutions.
Apache Licence 2.0 wording unchanged. Signatures path points at
signatures/version1/cla.json.
* CODE_OF_CONDUCT.md — Contributor Covenant v2.1 with the
oss@axonops.com enforcement contact.
* CONTRIBUTORS.md — generated from signatures/version1/cla.json
via scripts/generate-contributors.sh; byte-equality enforced by
TestGovernance_ContributorsFileIsGenerated.
* signatures/version1/cla.json — empty signedContributors
skeleton. CLA Assistant appends to this file on first signature.
* scripts/generate-contributors.sh — idempotent jq-driven
regenerator; mirrors mask's script with syncmap repo refs.
* .github/workflows/cla.yml — CLA Assistant wiring. Requires the
CLA_ASSISTANT_PAT repo secret for branch-protection bypass.
* .github/workflows/contributors.yml — triggers on signature
changes, regenerates CONTRIBUTORS.md, commits back to main via
github-actions[bot].
* .github/workflows/ci.yml — Markdown lint globs extended to
include CONTRIBUTING / CLA / CoC / CONTRIBUTORS.
* scripts/gen-llms-full.sh — source list now includes
CONTRIBUTING.md; llms-full.txt regenerated.
* documentation_test.go — seven new governance tests covering
presence, byte-equality, CLA/CoC/contributor workflow wiring,
and signatures-file schema.
Completes Phase 5 of the v1.0.0 roadmap. Coverage remains 100%.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes Phase 5 Part 2 — governance documentation + CLA Assistant automation + contributors regenerator. This is the last remaining issue in the v1.0.0 roadmap.
Closes #18.
What's in this PR
CONTRIBUTING.mdCLA.mdCODE_OF_CONDUCT.mdoss@axonops.comenforcement contact.CONTRIBUTORS.mdTestGovernance_ContributorsFileIsGeneratedenforces byte-equality.signatures/version1/cla.jsonsignedContributorsskeleton.scripts/generate-contributors.sh.github/workflows/cla.ymlCLA_ASSISTANT_PATsecret)..github/workflows/contributors.yml.github/workflows/ci.ymlscripts/gen-llms-full.shllms-full.txtdocumentation_test.goOperational prerequisite
The
cla.ymlworkflow requires aCLA_ASSISTANT_PATrepository secret withadmin:reposcope to bypass branch protection when it commits signatures. Create it manually at Settings → Secrets and variables → Actions before the first external PR lands. Without the secret, the workflow will run but the signature-push step will fail.Local validation
Agent gates
signatures/cla/cla.json→signatures/version1/cla.json), an agent-gate ordering issue in CONTRIBUTING (non-negotiable vs per-commit bucketing), and an American-spellingLicensein CONTRIBUTING's footer. All three fixed.v1.0.0 readiness
Merging this PR closes the last v1.0.0 roadmap item. After merge, the repo is ready for release via
workflow_dispatchofrelease.yml— the workflow runs the full gate, creates the tag fromgithub-actions[bot], runs GoReleaser, and warms the Go module proxy.Test plan
Markdown lintglobs and the 10TestGovernance_*testsllms-full.txt is up to datejob passes against the regenerated filedocumentation_test.go