Skip to content

Add PR Template#1172

Open
christiefhyang wants to merge 19 commits intomainfrom
christiefhyang
Open

Add PR Template#1172
christiefhyang wants to merge 19 commits intomainfrom
christiefhyang

Conversation

@christiefhyang
Copy link
Member

Pull Request Template Summary

  • Short Description of the PR
  • Feature scope
  • Category of the PR (Navigation/Manipulation/Perception)
  • Whether or not there's breaking changes
  • Effort Evaluation

Added a draft pull request template with sections for summary, features, scope, and effort estimates.
Removed draft notice from pull request template
@greptile-apps
Copy link

greptile-apps bot commented Feb 3, 2026

Greptile Overview

Greptile Summary

This PR adds a comprehensive pull request template to standardize PR submissions across the repository. The template includes well-structured sections for description, key features, scope definition, stack categorization (Navigation/Perception/Manipulation), breaking changes documentation, and effort estimation.

Key additions:

  • Clear guidance for PR authors with comment placeholders
  • Three primary stack categories that align with the project's robotics architecture
  • Breaking changes section with migration path documentation
  • Effort estimation (Small/Medium/Large) for project planning
  • Optional additional notes section for context and trade-offs

The template follows GitHub best practices and will improve PR quality and review efficiency by ensuring consistent information is provided upfront.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • The PR adds a documentation file (PR template) with no code changes, no dependencies, and no runtime impact. The template is well-structured, follows best practices, and aligns with the project's architecture categories.
  • No files require special attention

Important Files Changed

Filename Overview
pull_request_template.md Added comprehensive PR template with sections for description, feature scope, categories, breaking changes, and effort estimates

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant Template as PR Template
    participant Reviewer as Reviewer
    
    Dev->>GH: Create new pull request
    GH->>Template: Load pull_request_template.md
    Template->>GH: Populate PR description
    Dev->>GH: Fill in template sections
    Note over Dev,GH: - Short Description<br/>- Key Feature<br/>- Feature Scope<br/>- Category (Nav/Perception/Manip)<br/>- Breaking Changes<br/>- Effort Estimate
    Dev->>GH: Submit PR
    GH->>Reviewer: Notify with structured info
    Reviewer->>GH: Review with context
    Reviewer->>GH: Approve/Request changes
Loading

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Copy link
Member Author

@christiefhyang christiefhyang left a comment

Choose a reason for hiding this comment

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

Summary of changes in this PR

  • Added a CLA (CLA.md) to define contribution terms and ensure proper licensing of external contributions.

  • Added a PR test script (scripts/test_pr.sh) that runs basic checks and tests to verify changes locally and in CI.

  • Added a GitHub Actions workflow (.github/workflows/pr.yml) to automatically run the PR test script on every pull request.

  • Updated the pull request template (.github/pull_request_template.md) to:

    • Focus on Problem / Solution / Breaking Changes / How to Test
    • Require reproducible testing steps
    • Include CLA acknowledgment

Goal:
These changes establish a standard open-source workflow by adding contributor license, reproducible testing, and automated CI checks for all pull requests.

Copy link
Member Author

@christiefhyang christiefhyang left a comment

Choose a reason for hiding this comment

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

Updated workflow permissions

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.

3 participants