Pull_Request_Template #74
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a comprehensive Pull Request template to the repository at .github /pull_request/pull_request_template.md to ensure consistent and complete information in all future pull requests.
What Changed
Added a new PR template file that includes:
📝 Description of Changes: Section for contributors to provide clear descriptions of their modifications
🔗 Related Issues: Structured format for linking related issues using Fixes #(issue_number) syntax
📸 Screenshots: Optional section for visual changes (UI/UX updates, etc.)
🔄 Type of Change: Multiple-choice checklist covering:
Bug fixes
New features
Enhancements
Documentation updates
Test updates
Configuration changes
New agent development
✅ Comprehensive Checklist: Ensures contributors complete important steps including:
Self-review of code
Adherence to project style guidelines
Code documentation
Documentation updates
Test coverage
Issue linking
Breaking change verification
README updates when necessary
📋 Additional Notes: Space for any extra context or information
Benefits
✅ Consistency: All PRs will follow a standardized structure
✅ Faster Reviews: Maintainers have all necessary information upfront
✅ Better Quality: Checklist ensures contributors don't forget important steps
✅ Professional: Improves the overall contributor experience
✅ Alignment: Matches the style and guidelines in CONTRIBUTING.md
Design Decisions
Used emoji icons consistent with existing issue templates for better visual clarity
Included HTML comments to guide contributors on what to fill in each section
Added a comprehensive checklist that covers code quality, testing, and documentation
Kept the template flexible with optional sections (like screenshots) that can be removed when not applicable
Added project-specific options like "New agent development" under Type of Change
Closes #72