Repository navigation
docs: ask PRs about docs-site impact - #89
Merged
Merged
Conversation
Add a checklist item to the org-wide pull request template asking whether user-facing changes are reflected on the central docs site. Closes #88 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reviewer's GuideDocumentationAdd a checklist item asking contributors to account for the docs-site impact of user-facing changes.
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
uniqueg
marked this pull request as ready for review
November 17, 2026 08:10
Linked issuesChecked at commit deb01eb #88 docs: ask PRs about docs-site impact · 1 of 2 met · 1 to check by hand
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path=".github/pull_request_template.md" line_range="32-33" />
<code_context>
- [ ] Tests are added or updated where the change affects behaviour, and
pass.
- [ ] The documentation is updated where the change affects it.
+- [ ] User-facing change: the [docs site](https://github.com/elixir-cloud-aai/docs)
+ is updated, or an issue is opened there (or not needed).
- [ ] The title follows [Conventional
Commits](https://www.conventionalcommits.org/) (at most 50 characters,
</code_context>
<issue_to_address>
**Docs checklist stays hidden**
When a pull request is opened in prowes, gitHub selects prowes’s repository-local pull request template instead of this organization default, so authors do not see the docs-site checklist and are not prompted to address its impact.
Add the docs-site checklist to prowes’s repository-local pull request template.
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: .github/pull_request_template.md:33
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.
Summary
Adds one item to the checklist of the org-wide pull request template:
"User-facing change: the docs site is updated, or an issue is opened
there (or not needed)."
Closes #88
Part of elixir-cloud-aai/docs#152.
Repos with their own PR template
The org default applies only to repos without their own template. Among
the non-archived repos of the org, only one has its own:
prowes:PULL_REQUEST_TEMPLATE.md(root). Follow-up: add the linethere or drop the template in favour of the org default.
Verification
pre-commit run --all-files: all hooks pass, includingmarkdownlint-cli2; only
actionlintfailed locally because themachine's
shellcheckshim has no version set (unrelated to thischange, which touches no workflow).
Light lane
Template text only (one checklist item), no code, CI or permissions
changes, so both reviewer subagents are skipped; diff reviewed by hand.
Declined review findings
None
Open questions
None
🤖 Generated with Claude Code
Summary by Sourcery
Add documentation-site impact tracking to the organization-wide pull request checklist.
Enhancements:
Documentation: