docs(governance): add governance model, PR checks, and contribution templates - #2307
Open
marcus-souza-azion wants to merge 1 commit into
Open
docs(governance): add governance model, PR checks, and contribution templates#2307marcus-souza-azion wants to merge 1 commit into
marcus-souza-azion wants to merge 1 commit into
Conversation
marcus-souza-azion
force-pushed
the
docs-governance
branch
from
August 6, 2026 12:53
62099aa to
24b5886
Compare
…emplates
Adds GOVERNANCE.md describing how contributions move through the repo: roles,
what needs whose approval, PR conventions, review targets, and escalation.
Rules are written as expectations rather than claims about automation, so the
document stays true whether or not a check exists for a given rule.
Rewrites CONTRIBUTING.md and README.md around that flow, and points every doc
at the live docs URL instead of docs.azion.com. CODEOWNERS moves from named
individuals to teams and drops a broken RADME.md pattern.
Adds the first CI that runs on pull requests. Until now the only workflows
triggered on push, so nothing was checked before merge:
pr-checks.yml build + frontmatter validation on every PR to main
pr-title.yml conventional title, no ticket codes
weekly-linkcheck.yml internal link crawl, opens an issue on breakage
Deliberately left out, each with a comment in place explaining why:
- No slug gate. lint:slugcheck requires byte-identical paths across
languages and fails on 686 existing pt-br pages with localized slugs.
- No translation-drift job. package.json points it at
scripts/translation-status.ts, which does not exist in this repo.
- No accessibility job. The available scan covers the whole marketing
sitemap, cannot finish in its timeout, and reports to nobody.
- No PUBLIC_GITHUB_TOKEN in PR or scheduled runs. It only fills contributor
avatar lists, and fork PRs never receive secrets anyway.
package.json and the dev/stage/prod workflows are untouched; the pnpm
migration lands separately.
marcus-souza-azion
force-pushed
the
docs-governance
branch
from
August 6, 2026 13:09
24b5886 to
6d8e0e0
Compare
marcus-souza-azion
marked this pull request as ready for review
August 6, 2026 13:26
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What & why
Foundation: Establishes how contributions move through this repo, and adds the first CI that runs on pull requests.
Until now every workflow triggered on
pushtomain,dev, orstage. Nothing was checked before a merge, so a broken build or a duplicate permalink reachedmainbefore anyone found out.GOVERNANCE.mdis new: roles, what needs whose approval, PR conventions, review targets, and escalation. Rules are written as expectations of contributors and reviewers rather than as claims about automation, so the document stays true whether or not a check exists for any given rule.CONTRIBUTING.mdandREADME.mdare rewritten around that flow.CODEOWNERSmoves from four named individuals to teams and drops aRADME.mdpattern that never matched anything.Related issue: none
Pages affected: none. No published documentation changes here. Everything is
.github/plus the rootREADME.md.Type of change
feat)fix) — typo, broken link, wrong informationdocs) — rewrite, expansion, upkeepi18n)refactor/chore)What this adds to CI
pr-checks.ymlmainpr-title.ymlweekly-linkcheck.ymlAll three run against this PR, so this is their first real test.
Deliberately left out
Each has a comment in place explaining why, so nobody re-adds it as a fix.
No slug gate.
lint:slugcheckrequires byte-identical file paths across languages and currently exits 1 against 686 existingpt-brpages that use localized slugs (compatibilidade,contratos). Gating on it would block every PR. Worth revisiting only if identical cross-language slugs become the actual policy.No translation-drift job.
package.jsonpoints it atscripts/translation-status.ts, which does not exist in this repo. Only thescripts/lib/translation-status/helpers were ever written.No accessibility job. The available scan covers the full marketing sitemap at roughly 2,500 URLs, cannot finish inside a reasonable timeout, and reported to nobody.
package.jsonand thedev,stage, andprodworkflows are untouched. The pnpm migration lands in its own PR.Author checklist
type(scope): summary