Skip to content

Commit

Permalink
Update PR template (#1538)
Browse files Browse the repository at this point in the history
improved Description section for clarity
  • Loading branch information
saajann authored Dec 12, 2024
1 parent f2d0d71 commit 6d72f5e
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
## Description

**Please include:**
- A summary of the changes and the related issue
- Relevant motivation and context
- Any dependencies or environment changes required
- If this modifies AI/ML components, include model performance metrics

- **Summary of changes**: Clearly describe the key changes in this PR and their purpose.
- **Related issues**: Mention if this PR fixes or is connected to any issues (e.g., "Fixes #123" or "Relates to #456").
- **Motivation and context**: Explain the reason for the changes and the problem they solve.
- **Environment or dependencies**: Specify any changes in dependencies or environment configurations required for this update.
- **Impact on AI/ML components**: (If applicable) Describe changes to AI/ML models and include performance metrics (e.g., accuracy, F1-score).

Fixes # (issue)

Expand All @@ -30,4 +32,4 @@ Please check the options that are relevant:

## Additional Notes

Include any deployment notes, performance implications, or other relevant information:
Include any deployment notes, performance implications, or other relevant information:

0 comments on commit 6d72f5e

Please sign in to comment.