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

Define a pr template to encourage thorough pr descriptions #73

Merged
merged 2 commits into from Apr 15, 2024

Conversation

johnlk
Copy link
Collaborator

@johnlk johnlk commented Apr 14, 2024

Example for this change:

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

I've add 5 sections to the PR template, let me know if we need more:

  • type of PR
  • description
  • notes to the reviewer
  • how to test
  • links to issues addressed

Notes to Reviewer

Let me know if there's other ideas or sections we should consider adding.

How to test

N/A

Link to issues addressed

N/A

Copy link
Member

@JavierCane JavierCane left a comment

Choose a reason for hiding this comment

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

LGTM.

The only non-blocking suggestion would be to move the template to the .github/ directory in order to keep the root directory as clean as possible unifying all the GitHub related stuff in its own folder.

@johnlk
Copy link
Collaborator Author

johnlk commented Apr 15, 2024

LGTM.

The only non-blocking suggestion would be to move the template to the .github/ directory in order to keep the root directory as clean as possible unifying all the GitHub related stuff in its own folder.

Good call. For some reason, I thought this had to be in the root dir, but I guess not: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Fixing

@johnlk johnlk merged commit 1cc5389 into main Apr 15, 2024
2 checks passed
@johnlk johnlk deleted the john/add-pr-template branch April 15, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants