Skip to content

Commit

Permalink
Add Pull Request Template to the Project (#674)
Browse files Browse the repository at this point in the history
* Fiirst draft of pull_request_template.md
  • Loading branch information
f-PLT authored Jan 17, 2025
1 parent 2dadd69 commit cc42a26
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Summary
Brief description of what this PR does. (tl;dr).

### List of Changes
* Modified class X
* Added model Y
* Fixed problem Z
* etc.

### Related Issues
If the PR closes or is related to an issue, reference it here.
For example, "Closes #123", "Fixes #456" or "Relates to #741" .

## Detailed Description
A clear and detailed description of the changes, how they solve/fix the related issues.

Mention potential side effects or risks associated with the changes, if applicable.

### How to Test the Changes
Instructions on how to test the changes Include references to automated and/or manual tests that were created/used to test the changes.

### Screenshots
If applicable, add screenshots to help explain this PR (ex. Before and after for UI changes).

## Deployment Notes
Include instructions if this PR requires specific steps for its deployment (database migrations, config changes, etc.)

## Checklist

- [ ] I have tested these changes appropriately.
- [ ] I have added and/or modified relevant tests.
- [ ] I updated relevant documentation or comments.
- [ ] I have verified that this PR follows the project's coding standards.
- [ ] Any dependent changes have already been merged to main.

0 comments on commit cc42a26

Please sign in to comment.