-
Notifications
You must be signed in to change notification settings - Fork 10
Add PR Template #1172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add PR Template #1172
Conversation
Added a draft pull request template with sections for summary, features, scope, and effort estimates.
Removed draft notice from pull request template
Greptile OverviewGreptile SummaryThis 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:
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
Important Files Changed
Sequence DiagramsequenceDiagram
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
|
There was a problem hiding this 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
Updated the pull request template to include sections for problem, solution, breaking changes, and testing instructions.
This script runs various checks for Python, Node, and CMake projects, including linting, testing, and building.
Updated the Contributor License Agreement to clarify project ownership and licensing terms.
There was a problem hiding this 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.
christiefhyang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated workflow permissions
|
|
||
| ### One-command PR verification (required) | ||
| ```bash | ||
| bash scripts/test_pr.sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this for? I think people have to add their own command for how to test it.
Pull Request Template Summary