Skip to content

Add pull request template with testing checklist (#139)#211

Open
shifa-khan wants to merge 1 commit intoopendatahub-io:mainfrom
shifa-khan:pr-template
Open

Add pull request template with testing checklist (#139)#211
shifa-khan wants to merge 1 commit intoopendatahub-io:mainfrom
shifa-khan:pr-template

Conversation

@shifa-khan
Copy link
Copy Markdown
Contributor

@shifa-khan shifa-khan commented Apr 22, 2026

Add .github/PULL_REQUEST_TEMPLATE.md with What/Why sections and a checklist covering signed commits, linting (ruff + Hadolint), template editing workflow, and container image standards. Checklist is split into items that apply to all PRs vs. Containerfile-specific changes.

Closes #139

Summary by CodeRabbit

  • Chores
    • Added a GitHub pull request template prompting a concise change description and issue linkage, and enforcing quality checklists (lint/format/type checks and tests). Includes a container/image checklist requiring edits to canonical container templates and regeneration via the generator, containerfile linting, use of build args for versions/URLs (no hardcoded values), successful image builds, prohibition of :latest tags, and disallowing root (UID 0) users.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: fa674a34-6d78-4576-99bc-d3ddfd98c4fb

📥 Commits

Reviewing files that changed from the base of the PR and between 627cc8a and b87f9b3.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md
✅ Files skipped from review due to trivial changes (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

Adds a GitHub Pull Request template at .github/PULL_REQUEST_TEMPLATE.md that requires a brief "What" description and "Why / Closes #" linkage, and enforces three checklists: general quality gates (linting/formatting/type checks), image build & test verification with explicit commands (tox -e lint, tox -e type, ./scripts/build.sh <type>-<version>, pytest tests/ -v with image env vars), and repo-specific rules (edit Containerfile templates not versioned files, use app.conf build args, avoid :latest, and ensure final image does not run as root). Lines changed: +23/-0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding a pull request template with a testing checklist, matching the linked issue #139.
Linked Issues check ✅ Passed The pull request implements all required components from issue #139: What/Why sections, testing checklist with tox/build/pytest commands, and repo-specific reminders for template editing and build standards.
Out of Scope Changes check ✅ Passed All changes are scoped to the pull request template requirement. The single file modification (.github/PULL_REQUEST_TEMPLATE.md) directly addresses issue #139 with no extraneous changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 14: The checklist item "[ ] Commits are signed (`git commit -s`)" is
misleading because `git commit -s` adds a DCO sign-off, not a cryptographic
signature; update that checklist entry to either say "signed-off (DCO) (`git
commit -s`)" or change the command to a signing flow such as "`git commit -S`"
depending on repository policy so the wording and command match; ensure the
updated text replaces the existing checklist line exactly to avoid confusion.
- Around line 13-24: Update the PR checklist to include the missing quality
gates: under the "All PRs" section add checkboxes for running `tox -e <type>`
(for relevant build types) and for running `pytest tests/ -v` with note to set
the appropriate `*_IMAGE` env vars (e.g., `BASE_IMAGE`, `PYTHON_IMAGE`) so CI
covers those gates; in the "Containerfile / image changes" section revert the
containerfile linting guidance to point to the canonical `tox -e lint` gate
(remove or deprecate `./scripts/lint-containerfile.sh`) and ensure the template
mentions using `./scripts/generate-containerfile.sh` and `./scripts/build.sh
<type>-<version>` as before; update the checklist text entries (headers "All
PRs" and "Containerfile / image changes") and command strings to reflect these
required checks.
🪄 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: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 2182fba5-1aaf-4bea-802e-5708192fe832

📥 Commits

Reviewing files that changed from the base of the PR and between 3f72475 and 627cc8a.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md

Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Add .github/PULL_REQUEST_TEMPLATE.md with What/Why sections and a
checklist covering signed commits, linting (ruff + Hadolint), template
editing workflow, and container image standards. Checklist is split
into items that apply to all PRs vs. Containerfile-specific changes.

Closes opendatahub-io#139
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.

Add pull request template with testing checklist

1 participant