Skip to content

docs: use SDK PR template#2756

Open
kushalsai-01 wants to merge 1 commit intoOpenHands:mainfrom
kushalsai-01:fix/pr-template-sync-openhands-2729
Open

docs: use SDK PR template#2756
kushalsai-01 wants to merge 1 commit intoOpenHands:mainfrom
kushalsai-01:fix/pr-template-sync-openhands-2729

Conversation

@kushalsai-01
Copy link
Copy Markdown
Contributor

This PR updates the SDK pull request template to match the upstream OpenHands repository format.

Why

Keeping the PR template aligned with upstream ensures consistency in contribution workflows, reduces reviewer friction, and standardizes expectations across repositories.

What’s changed

  • Synced PR template structure with OpenHands upstream
  • Updated sections for clarity and completeness
  • Improved checklist to reflect current contribution requirements

Impact

  • No functional/code changes
  • Affects contributor experience and PR quality only

Align the SDK PR template with the upstream OpenHands format to keep contribution workflow consistent.

Made-with: Cursor
Copilot AI review requested due to automatic review settings April 8, 2026 17:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s pull request template to match the upstream OpenHands PR template format for more consistent contribution workflows.

Changes:

  • Replaced the existing PR template with an upstream-aligned structure (Why/Summary/Issue/How to Test/Type/Notes).
  • Updated contributor prompts and checklists to reflect the new standard.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 13 to +17
## Summary

[fill in a summary of this PR]

-

Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

Line 16 is an empty Markdown list item (-) under “## Summary”, which will render as a blank bullet and looks accidental. Remove it or replace it with a real placeholder (e.g., an HTML comment prompt).

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +5




- [ ] A human has tested these changes.
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

There are several whitespace-only lines (e.g., lines 3, 11, 15, 19, 23, 27, 39). Trailing spaces in Markdown can create unintended formatting (hard line breaks) and adds noise to diffs; consider trimming these to truly blank lines.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@copilot apply changes based on this feedback

@all-hands-bot
Copy link
Copy Markdown
Collaborator

[Automatic Post]: It has been a while since there was any activity on this PR. @kushalsai-01, are you still working on it? If so, please go ahead, if not then please request review, close it, or request that someone else follow up.

@enyst enyst changed the title docs: align SDK PR template with OpenHands upstream standard docs: use SDK PR template Apr 15, 2026
- [ ] If there are instructions on how to run the code, have you followed the instructions and made sure that it works?
- [ ] If the feature is significant enough to require documentation, is there a PR open on the OpenHands/docs repository with the same branch name?
- [ ] Is the github CI passing?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If there are no Notes, maybe we can remove the Notes section entirely?

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.

4 participants