docs: housekeeping — sync CONTRIBUTING.md, update README and DE translation - #695
Merged
rdmueller merged 5 commits intoJul 18, 2026
Conversation
…DE translation Housekeeping: align documentation files with recent structural changes. - CONTRIBUTING.md: rewrite to match CONTRIBUTING.adoc content - README.adoc: update anchor count (60+ → 180+), add role taxonomy (operational + governance), link to docs/roles/ - CONTRIBUTING.adoc: add build artifacts note + reviewer checklist item - docs/CONTRIBUTING.de.adoc: add missing sections (developer setup, PR review policy, reviewer checklist, criticism/current status, code of conduct), update role taxonomy with German display names, add :tier: to metadata documentation
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughDie Beitragsdokumentation wurde neu strukturiert und um Anchor-Definitionen, Test- und Erstellungsabläufe, Rollen, Metadaten-, Review- und Verhaltensrichtlinien erweitert. README und deutsche Dokumentation wurden an aktualisierte Katalog- und Metadatenangaben angepasst. ChangesDokumentations- und Beitragsrichtlinien
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.adoc`:
- Line 321: Synchronize the metadata contract in CONTRIBUTING.adoc with the
other contribution guides: update the example’s role ID from architect to
software-architect and add tier to the required-attributes checklist. Preserve
the existing no-build-artifacts rule and align the wording and required values
with CONTRIBUTING.md and docs/CONTRIBUTING.de.adoc.
In `@CONTRIBUTING.md`:
- Line 90: Update the prompt code block in CONTRIBUTING.md to include an
explicit language identifier, such as text or markdown, immediately after the
opening fence so it satisfies markdownlint MD040.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 00be0d94-6821-4a77-b434-9ffd896d3ca8
📒 Files selected for processing (4)
CONTRIBUTING.adocCONTRIBUTING.mdREADME.adocdocs/CONTRIBUTING.de.adoc
added 2 commits
July 16, 2026 16:06
- Fix role ID: architect → software-architect in example - Add :tier: to required metadata in reviewer checklist - Add :tier: to anchor file format example
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.adoc`:
- Around line 192-196: Ergänze im Abschnitt „Required Metadata“ die Beschreibung
von :tier: als Pflichtattribut. Positioniere sie konsistent neben den
bestehenden Metadatenanforderungen und verwende die bereits im Dokument
etablierte Bedeutung bzw. Formulierung für tier.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 33766da0-d24b-45c2-a84e-35411d860bfe
📒 Files selected for processing (1)
CONTRIBUTING.adoc
Member
|
thanx! |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor-facing documentation to match the repository’s recent taxonomy/metadata and workflow changes (role IDs incl. governance roles, :tier: metadata, and CI/guidance around build artifacts), keeping README and EN/DE contributing guides consistent.
Changes:
- Rewrites
CONTRIBUTING.mdto align with the AsciiDoc contribution guide (artifact taxonomy, viability test, role IDs, review policy, metadata incl.:tier:). - Updates
README.adocto reflect the larger catalog size and the structured role taxonomy, with a pointer todocs/roles/. - Extends
CONTRIBUTING.adocanddocs/CONTRIBUTING.de.adocwith build-artifact guidance,:tier:metadata, and updated role IDs/examples.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.adoc | Updates catalog size and replaces the flat role list with operational + governance role IDs and a link to role docs. |
| CONTRIBUTING.md | Full rewrite to document artifact taxonomy, anchor gates, developer setup, metadata (:tier:), roles, and review policy. |
| CONTRIBUTING.adoc | Adds build-artifact NOTE, updates role example (software-architect), documents :tier:, and adds reviewer checklist item. |
| docs/CONTRIBUTING.de.adoc | German contributing guide updates: role ID tables, developer setup, review policy/checklist, :tier: docs, and expanded code of conduct. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| [source,bash] | ||
| ---- | ||
| ./pre-commit-install.sh |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This was referenced Jul 24, 2026
raifdmueller
added a commit
to raifdmueller/Semantic-Anchors
that referenced
this pull request
Jul 24, 2026
The /de/contributing page was built from website/public/CONTRIBUTING.de.adoc, while every contributor edit since LLM-Coding#603 went into docs/CONTRIBUTING.de.adoc — the file next to its English sibling. Nothing rendered that file, so German readers never saw the artifact taxonomy (LLM-Coding#585), the Viability Test (LLM-Coding#640), the ADR-008 topic-neutral gate, the issue-title convention (LLM-Coding#564), or the developer setup, PR review policy and Criticism/Current-Status rules from LLM-Coding#695. - render-docs.js renders docs/CONTRIBUTING.de.adoc; the stale public/ copy is deleted, leaving one German source - rewrite five relative link: targets in both Contributing files (ADR-007, ADR-008, docs/roles/) that resolved against the served route and 404'd - gitignore the generated CONTRIBUTING*.toc.html build artifacts Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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.
Housekeeping: align documentation with recent structural changes
After merging governance roles (#659), role descriptions (#691), and metadata parity fixes (#690), several documentation files drifted out of sync. This PR catches them up.
Changes
CONTRIBUTING.md (complete rewrite to match CONTRIBUTING.adoc):
:tier:README.adoc:
docs/roles/for detailed descriptionsCONTRIBUTING.adoc:
docs/CONTRIBUTING.de.adoc:
:tier:to metadata documentation and examplearchitect→software-architectin exampleNot in scope
roles.json/docs/metadata/roles.ymlsynchronization (separate PR)docs/CONTRIBUTING.de.adoccategories section (already present and current)Housekeeping: Dokumentation an aktuelle Strukturänderungen angleichen
Nach dem Merge von Governance-Rollen (#659), Rollenbeschreibungen (#691) und Metadaten-Parity-Fixes (#690) waren mehrere Dokumentationsdateien nicht mehr synchron. Dieser PR zieht sie nach.
Änderungen
CONTRIBUTING.md (komplett neu geschrieben, synchron mit CONTRIBUTING.adoc):
:tier:README.adoc:
docs/roles/für DetailbeschreibungenCONTRIBUTING.adoc:
docs/CONTRIBUTING.de.adoc:
:tier:in Metadaten-Dokumentation und Beispielarchitect→software-architectim Beispiel korrigiertSummary by CodeRabbit