Skip to content
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

Create pr_template.md #20

Merged
merged 2 commits into from
Oct 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions .github/ PULL_REQUEST_TEMPLATE/pr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Pull Request Template

## Description

**Summary:**

🚀 [Provide a brief summary of the changes or enhancements introduced by this PR.]

**Related Issue:**

🔗 [Link to the relevant issue(s) that this PR addresses. If no issue exists, briefly explain why this PR is necessary.]

## Type of Change

Please check the appropriate box and explain the change you've made:

- 🐛 Bug Fix
- [ ] This PR fixes an existing bug.
- [ ] The issue is identified as #[issue_number].

- ✨ New Feature
- [ ] This PR introduces a new feature.
- [ ] The feature is discussed and documented in #[link_to_discussion].

- 🚀 Enhancement/Improvement
- [ ] This PR makes improvements or enhancements to existing functionality.
- [ ] The enhancements are described in detail below.

- 📝 Documentation Update
- [ ] This PR updates the project's documentation.
- [ ] Documentation changes are explained below.

- ♻️ Code Refactoring
- [ ] This PR refactors existing code without changing its behavior.
- [ ] The reasons for refactoring are explained below.

## Screenshots or GIFs (if applicable)

[Insert screenshots or GIFs demonstrating the changes made in this PR, if relevant.]

<!-- Replace with your GIF URL -->
![GIF Placeholder](https://via.placeholder.com/300)

## Checklist

Before submitting this PR, please ensure the following:

- [ ] I have read and followed the project's contributing guidelines.
- [ ] I have tested the changes locally and they work as expected.
- [ ] I have provided proper documentation or comments for the code changes.
- [ ] I have included relevant test cases (if applicable).
- [ ] My code follows the project's coding standards.
- [ ] I have rebased my branch onto the latest main/development branch.
- [ ] I have resolved any merge conflicts.

## Additional Comments

[Provide any additional information, context, or details that are important for reviewers to know.]

## Reviewers

[Tag relevant team members or contributors who should review this PR.]

## Closing Notes

- [ ] This PR is ready for review.
- [ ] This PR is a work in progress and should not be merged yet.
- [ ] This PR is dependent on another PR, #[link_to_dependent_pr], which needs to be merged first.

## Related Issues or PRs

[Link to any related Issues or PRs if applicable. Eg: `#01`]

<br>

Also link dependent issues that will be closed when the PR is merged, Eg: Resolves `#01`