docs: suggest updating repo description/topics for new software support - #276
Open
crowecawcaw wants to merge 1 commit into
Open
Conversation
The repository description and topics are how people searching GitHub for a specific application or workload discover these samples. When a PR adds support for new software, that discoverability only happens if a maintainer remembers to update the metadata, so prompt for it in the PR template. Signed-off-by: Stephen Crowe <6042774+crowecawcaw@users.noreply.github.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
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 was the problem/requirement? (What/Why)
The repository description and topics list are the main way someone searching GitHub for a specific application (Maya, CARLA, RELION, and so on) or a kind of workload finds these samples. Both are already maintained: the description names the workload categories, and there are topics for individual applications like
blender,houdini,nuke,carla, andmujuco.Nothing in the contribution flow reminds anyone to extend that metadata. A PR can add a fully working sample for software the repository has never covered, get merged, and remain invisible to the searches that would have found it.
What was the solution? (How)
Add one bullet to the "Was this change documented?" section of the pull request template asking the contributor to call out when a change adds support for new software or a new kind of workload, so a maintainer can update the repository description or topics. Repository metadata is not editable through a PR, so the template asks the contributor to flag it rather than change it.
What is the impact of this change?
New-software PRs surface the metadata gap while a maintainer is already looking at the change. No effect on existing samples, validation, or CI.
How was this change tested?
python3 scripts/validate_repository.py— 35 unit tests pass, 163 Markdown files link-checked, "Repository validation passed".vale .github/PULL_REQUEST_TEMPLATE.md— 0 errors, 0 warnings, 0 suggestions.Was this change documented?
The change is itself documentation.
CONTRIBUTING.mdandAGENTS.mddescribe the code and index updates a contribution needs; neither covers repository-level metadata, which is a maintainer action rather than a checklist item, so the prompt lives in the PR template only.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.