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

feat: Add Pull Request Template for GitHub issue #13 #20

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Conversation

CKCarr
Copy link
Collaborator

@CKCarr CKCarr commented Feb 18, 2024

This PR introduces a comprehensive and standardized Pull Request Template to streamline submission and review processes. By providing a clear structure for contributors, we aim to ensure consistency across PRs and facilitate easier understanding and evaluation of contributions. The template includes sections for describing changes, type of change, testing procedures, and a checklist for review standards.

Related to issue #13.
Closes #13

Please review the template for any adjustments or improvements needed.

@CKCarr CKCarr added the documentation Improvements or additions to documentation label Feb 18, 2024
Copy link
Member

@helmturner helmturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

This is a comprehensive template, but I think it can be slimmed down a bit so people don't 'tl;dr'. I've left some recommendations in my review. If anything I've dropped still seems important it can probably be moved to CONTRIBUTING.md

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
Copy link
Member

@helmturner helmturner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(duplicate)

integrate Alec Helmturner's adjustments

Co-authored-by: Alec Helmturner <[email protected]>
.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@zenlex
Copy link
Contributor

zenlex commented Feb 21, 2024

@CKCarr I committed @helmturner's suggestions. Looks great to me if you want to give it one more pass and mark it ready for review and merge it, it's been approved.

@CKCarr CKCarr marked this pull request as ready for review February 21, 2024 02:26
@CKCarr CKCarr merged commit e6ca8fb into dev Feb 21, 2024
1 check passed
@CKCarr CKCarr deleted the doc/pr-template branch February 21, 2024 02:53
zenlex added a commit that referenced this pull request Apr 27, 2024
* feat: Add Pull Request Template for GitHub issue #13

* Apply suggestions from code review

integrate Alec Helmturner's adjustments

Co-authored-by: Alec Helmturner <[email protected]>

---------

Co-authored-by: Erich Keil <[email protected]>
Co-authored-by: Alec Helmturner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Pull Request Template
3 participants