Skip to content

docs: add pull request template with AI disclosure and e2e requirement - #1553

Merged
skevetter merged 2 commits into
mainfrom
docs/pull-request-template
Oct 18, 2026
Merged

skevetter merged 2 commits into
mainfrom
docs/pull-request-template

Conversation

@skevetter

@skevetter skevetter commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Adds .github/pull_request_template.md and a Pull Requests section in CONTRIBUTING.md.

Template covers: what/why, type of change, AI assistance disclosure (tool, model, usage, human review), integration test requirement with an explicit opt-out justification, lint/test/docs/CLA checklist.

Summary by CodeRabbit

  • Documentation
    • Added pull request guidance covering title format, change descriptions, testing expectations, AI-use disclosure, and reviewer notes.

@netlify

netlify Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev canceled.

Name Link
🔨 Latest commit 90e4e98
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6ad50adc36bce579f3697cf0

@netlify

netlify Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 90e4e98
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6ad50adc5a797162be237ffe

@coderabbitai

coderabbitai Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 48 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2bdd6b5a-60f7-4430-a3fc-9251e081378c
📥 Commits

Reviewing files that changed from the base of the PR and between a26cc19 and 90e4e98.

📒 Files selected for processing: 2
  • .github/pull_request_template.md
  • CONTRIBUTING.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 17f645b3-5ddc-4069-9be2-41bdc627331d
📥 Commits

Reviewing files that changed from the base of the PR and between e48bba9 and a26cc19.

📒 Files selected for processing: 2
  • .github/pull_request_template.md
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

📝 Walkthrough

The pull request adds a template for submission details, AI-use disclosure, testing, and checklist confirmations. It also adds contributor guidance on AI-use disclosure, integration-test coverage, and Conventional Commit titles.

Changes: Pull request guidance

Layer / File(s) Summary
Pull request submission guidance
.github/pull_request_template.md, CONTRIBUTING.md
The template requests a change description, issue reference, change type, AI-use disclosure, testing and manual verification details, and checklist confirmations. The contributor guide describes AI-use disclosure, integration-test coverage or an explanation for omitting it, and Conventional Commit titles.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to a26cc

The PR adds submission and verification guidance that points contributors to existing checks and clearly requests the intended disclosures. No concrete merge-blocking risk remains.

### Architecture Summary

Architecture risk: 🔵 Low · up to a26cc

The change affects 1 system.

Changed systems: CONTRIBUTING.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.md: Adds pull request guidance covering AI-use disclosure, integration-test coverage or an explanation for omitting it, and Conventional Commit titles.
  • observed — Modified behavior in .github/pull_request_template.md: Added introductory guidance, a change description and issue-reference section, and checkboxes for the type of change, including breaking changes.
  • observed — Modified behavior in .github/pull_request_template.md: Added AI-use disclosure options, fields for the tool, its use, and its share of the change, plus contributor confirmations about understanding and running the change.
  • observed — Modified behavior in .github/pull_request_template.md: Added testing guidance requiring integration-test coverage for behavior changes affecting named product areas, test-reporting options, and a prompt for manual verification details.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main changes: adding a pull request template, AI disclosure, and an end-to-end testing requirement.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
✨ Simplify code
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@skevetter

Copy link
Copy Markdown
Contributor Author

@greptileai review

@mergify

mergify Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@greptile-apps

greptile-apps Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; the conflicting desktop testing instructions are fixed.

Summary

Adds a pull request template and contributor guidance covering AI use, integration tests, and review checklists.

  • Pull requests now start with clear prompts for change details and review evidence.

Reviews (2) · Last reviewed commit: "docs: split CLI and desktop e2e requirem..." · Reviewed by Greptile

Comment thread CONTRIBUTING.md Resolved
@skevetter

Copy link
Copy Markdown
Contributor Author

@greptileai review

@skevetter
skevetter merged commit 7357c5a into main Oct 18, 2026
37 checks passed
@skevetter
skevetter deleted the docs/pull-request-template branch October 18, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant