docs: scope the terminology ban with actor rules and exemptions - #127
Open
mlehotskylf wants to merge 2 commits into
Open
docs: scope the terminology ban with actor rules and exemptions#127mlehotskylf wants to merge 2 commits into
mlehotskylf wants to merge 2 commits into
Conversation
The Terminology section banned "maintainer" and "apprentice" without saying which occurrences were out of scope, so every sweep re-litigated the same false positives, and one class of error slipped through entirely. - Add "Who does what": Program Admins create and administer programs; open-source maintainers do not, they work with a Program Admin and often become mentors. UI copy claiming that maintainers enrol programs uses no banned term but names the wrong actor. - Replace the single legacy-docs exception with an Exemptions list covering legacy descriptions, third-party identifiers (Helm's Chart.yaml maintainers: key, the apprenticeNeeds DynamoDB fallback in migrate_dynamo_to_postgres.py), and "maintainer" in its ordinary English sense. - Point the PR checklist item at both subsections. Signed-off-by: Michal Lehotsky <mlehotsky@linuxfoundation.org>
There was a problem hiding this comment.
Pull request overview
Clarifies terminology rules to distinguish Program Admins from open-source maintainers and document valid exemptions.
Changes:
- Adds actor-specific terminology guidance.
- Documents legacy and third-party identifier exemptions.
- Expands the terminology self-review checklist.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Why
The Terminology section added in #124 bans
maintainerandapprenticebut never says which occurrences are out of scope. Two consequences showed up while reviewing #125:maintainers:key, theapprenticeNeedsDynamoDB fallback, and the ordinary-English uses of "maintainer" were each argued from scratch, with no record of the conclusion.Changes
All in
CLAUDE.md, under Terminology:maintainers:inChart.yaml, andmigrate_dynamo_to_postgres.pyreadsapprenticeNeedsas a fallback for records predating thementeeNeedsrenamemaintainerin its ordinary English sense — mentees are paired with maintainers (who serve as mentors) and may become maintainers themselvesVerified
Each exemption was checked against the code rather than taken from memory:
backend/charts/lfx-mentorship-backend/Chart.yaml:17is the onlymaintainers:in the chart; no values key or template uses either banned term.migrate_dynamo_to_postgres.py:504readsp.get("menteeNeeds") or p.get("apprenticeNeeds")— a fallback, not the primary field name. An earlier draft of this text described it as simply "the DynamoDB field name"; corrected before commit.001_initial.up.sql:154confirmsmember_typeencodesprogram_admin | mentor.Documentation only — no code, schema, or chart changes.
🤖 Generated with Claude Code