Skip to content

docs: ask PRs about docs-site impact - #89

Merged
uniqueg merged 1 commit into
mainfrom
docs/88-docs-site-checkbox
Nov 17, 2026
Merged

uniqueg merged 1 commit into
mainfrom
docs/88-docs-site-checkbox

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

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 line
    there or drop the template in favour of the org default.

Verification

  • pre-commit run --all-files: all hooks pass, including
    markdownlint-cli2; only actionlint failed locally because the
    machine's shellcheck shim has no version set (unrelated to this
    change, which touches no workflow).
  • CI: all checks passed (CI passed, Lint, Test, CodeQL).

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:

  • Update the organization-wide pull request template to require contributors to confirm that user-facing documentation-site changes are addressed or tracked.

Documentation:

  • Add a pull request checklist item linking to the documentation repository and covering updates, issue tracking, or cases where no documentation change is needed.

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>
@uniqueg uniqueg self-assigned this Nov 17, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 17, 2026

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Add a checklist item asking contributors to account for the docs-site impact of user-facing changes.

  • .github/pull_request_template.md L32-33

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg
uniqueg marked this pull request as ready for review November 17, 2026 08:10
@sourcery-ai

sourcery-ai Bot commented Nov 17, 2026

Copy link
Copy Markdown

Linked issues

Checked at commit deb01eb

#88 docs: ask PRs about docs-site impact · 1 of 2 met · 1 to check by hand

# Requirement Status Notes
1 Add the docs-site item to the org pull request template. ✅ Met Added to the checklist in .github/pull_request_template.md.
2 Check which service repos have their own template and list them in the PR. 👀 Check by hand (external system) The PR description lists prowes as the only non-archived repo with its own template; a person must verify that inventory against the org’s repositories.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread .github/pull_request_template.md Resolved
@uniqueg
uniqueg merged commit 3405947 into main Nov 17, 2026
7 checks passed
@uniqueg
uniqueg deleted the docs/88-docs-site-checkbox branch November 17, 2026 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: ask PRs about docs-site impact

1 participant