Skip to content

Add comprehensive PR template from OpenHands repository#441

Open
jamiechicago312 wants to merge 2 commits intomainfrom
openhands/add-pr-template
Open

Add comprehensive PR template from OpenHands repository#441
jamiechicago312 wants to merge 2 commits intomainfrom
openhands/add-pr-template

Conversation

@jamiechicago312
Copy link
Copy Markdown
Collaborator

@jamiechicago312 jamiechicago312 commented Apr 6, 2026

  • A human has tested these changes.

Why

The docs repository was using a minimal PR template that lacked important sections for structured pull request documentation. This update brings the comprehensive PR template from the main OpenHands repository to ensure consistency across the project.

Summary

  • Replaced minimal PR template with comprehensive template from OpenHands/OpenHands repository
  • Added sections for Why, Summary, Issue Number, How to Test, Video/Screenshots, Type, and Notes
  • Included checklist for human testing and guidance for AI/LLM agents

Issue Number

Fixes #440

How to Test

  1. After this PR is merged, create a new pull request in the docs repository
  2. Verify that the new PR template automatically appears with all sections
  3. Confirm the template includes sections for Why, Summary, Issue Number, How to Test, Video/Screenshots, Type, and Notes

Video/Screenshots

N/A - This is a configuration file change that will be visible when creating future PRs.

Type

  • Bug fix
  • Feature
  • Refactor
  • Breaking change
  • Docs / chore

Notes

This PR template is now consistent with the main OpenHands repository, which will help maintain uniformity in documentation standards across all OpenHands projects.

@jamiechicago312 can click here to continue refining the PR

- Replace simple PR template with comprehensive template from main OpenHands repo
- Add sections for Why, Summary, Issue Number, How to Test, Video/Screenshots, Type, and Notes
- Include checklist for human testing and guidance for AI/LLM agents

Fixes #440
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 6, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 6, 2026, 8:35 PM

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟡 Acceptable - Template is well-formed, but importing a generic code-repo template loses valuable doc-specific guidance. Consider whether all requirements are proportional for documentation changes.

@jamiechicago312
Copy link
Copy Markdown
Collaborator Author

@OpenHands resolve these suggestions i think they are valid. keep it succinct. push to the pr

@openhands-ai
Copy link
Copy Markdown

openhands-ai bot commented Apr 6, 2026

I'm on it! jamiechicago312 can track my progress at all-hands.dev

- Add checklist for local preview validation
- Make testing section flexible for simple doc changes
- Clarify video/screenshot requirements for docs
@openhands-ai
Copy link
Copy Markdown

openhands-ai bot commented Apr 6, 2026

Summary

I successfully resolved all review suggestions on PR #441 and pushed the changes.

Request Completion Checklist:

  • ✅ Resolved all 3 review suggestions (kept succinct as requested)
  • ✅ Pushed changes to the PR branch (openhands/add-pr-template)
  • ✅ Replied to and resolved all review threads with commit reference

Changes Made (commit ab22f19):

  1. Added doc-specific checklist - New item for local preview validation using mint dev
  2. Made testing section flexible - Updated "How to Test" guidance to allow simple doc changes to skip elaborate testing steps
  3. Clarified video/screenshot requirements - Specified when screenshots are needed vs. when "N/A - text-only change" is acceptable

All changes were minimal, targeted, and directly addressed the reviewer's valid suggestions about making the PR template more appropriate for a documentation repository rather than a code repository.

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.

[feature] new pr template

3 participants