[docs] Add template to github PRs DRAFT

[tepals]

Compliance:

• Hardware: Does this change control logic, power limits, or physical movement?
• Security: Does this affect data encryption, user permissions, or network ports?
• Compliance: Does this alter a feature described in the Technical File or Intended Use?

[coderabbitai]

📝 Walkthrough

Walkthrough

PULL_REQUEST_TEMPLATE.md now includes a top-level compliance checklist with Hardware, Security, and Compliance items, plus a feature-flag checklist. .github/copilot-instructions.md now includes guidance for general code review standards, a compliance subsection, and checking PR items against the template.

Possibly related PRs

• delmic/odemis#3316: Also updates .github/copilot-instructions.md with new review guidance in the same area.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is directly related to the added compliance checklist items in the PR template.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly matches the main change: adding a PR template/checklist for GitHub PRs.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

🧹 Nitpick comments (2)

PULL_REQUEST_TEMPLATE.md (2)

1-3: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Expand the PR template with standard sections.

The current template is too minimal. Consider adding:

• Description: What changes and why.
• Related Issue: Link to tracked issues.
• Type of Change: Bug fix, feature, refactor, docs, etc.
• Testing Performed: Specific tests run, environments, how to reproduce/verify.
• Documentation: What docs were updated or why none were needed.
• Screenshots/GIFs: For UI changes.
• Breaking Changes: API or behavior changes that affect users.

This makes the template actionable and improves PR quality across the project.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@PULL_REQUEST_TEMPLATE.md` around lines 1 - 3, The PR template is too minimal
and only includes a Doneness checklist; expand PULL_REQUEST_TEMPLATE.md with
standard sections such as Description, Related Issue, Type of Change, Testing
Performed, Documentation, Screenshots/GIFs, and Breaking Changes. Update the
template content itself so contributors are prompted to fill these sections
consistently and the checklist remains part of the template if still needed.

---

2-3: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Clarify checklist items to be actionable.

"Testing" and "Documentation" are too vague to verify during review. Make them specific:

• - [ ] I have added/updated tests that cover these changes, or confirmed no tests are needed (with reason).
• - [ ] I have updated relevant documentation (README, API docs, user guide), or confirmed no docs updates are needed (with reason).

This helps authors self-verify and reviewers confirm completeness.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@PULL_REQUEST_TEMPLATE.md` around lines 2 - 3, The checklist items in the pull
request template are too vague and should be made actionable. Update the
template’s existing “Testing” and “Documentation” entries to require authors to
confirm either the relevant tests/docs were added or updated, or that none were
needed with a brief reason, so reviewers can verify completeness from the
template itself.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@PULL_REQUEST_TEMPLATE.md`:
- Around line 1-3: The PR template is too minimal and only includes a Doneness
checklist; expand PULL_REQUEST_TEMPLATE.md with standard sections such as
Description, Related Issue, Type of Change, Testing Performed, Documentation,
Screenshots/GIFs, and Breaking Changes. Update the template content itself so
contributors are prompted to fill these sections consistently and the checklist
remains part of the template if still needed.
- Around line 2-3: The checklist items in the pull request template are too
vague and should be made actionable. Update the template’s existing “Testing”
and “Documentation” entries to require authors to confirm either the relevant
tests/docs were added or updated, or that none were needed with a brief reason,
so reviewers can verify completeness from the template itself.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 63546d67-f574-4dd3-b2ae-33a3b6ab9e6b

📥 Commits

Reviewing files that changed from the base of the PR and between 30e771a and 5adcc19.

📒 Files selected for processing (1)

• PULL_REQUEST_TEMPLATE.md

[Copilot]

Pull request overview

Adds a GitHub pull request template and updates the repository’s Copilot review instructions to incorporate compliance/security considerations during PR review.

Changes:

• Added PULL_REQUEST_TEMPLATE.md with a “Doneness” checklist focused on hardware, security, and compliance impact.
• Updated .github/copilot-instructions.md to add a “General Code Review Standards / Compliance” section referencing the PR template.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
PULL_REQUEST_TEMPLATE.md	Introduces a PR checklist intended to prompt reviewers/authors about hardware/security/compliance impact.
.github/copilot-instructions.md	Adds review guidance pointing Copilot/reviewers to consider checklist relevance during review.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.