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 pull_request_template.md #210

Merged
merged 1 commit into from
Dec 7, 2022
Merged

Create pull_request_template.md #210

merged 1 commit into from
Dec 7, 2022

Conversation

joellabes
Copy link
Contributor

Bringing the checklist into the PR flow to help people see it!

Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

Love adding this as a pull request template!

I'll be curious if the number of checklist items is manageable or overwhelming.

According to Amazon, 7,454 Kindle readers highlighted this section of the Checklist Manifesto:

The checklist cannot be lengthy. A rule of thumb some use is to keep it to between five and nine items, which is the limit of working memory.

But since this is a one-time checklist (rather than a repeated one), it's quite possible that we'd rather have it be trending towards "comprehensive" rather than "minimal".

In the future, we may also want different PR templates for internal script changes vs. listing of packages.

Let's ship it as-is and then iterate as-needed. :shipit:

@dbeatty10 dbeatty10 merged commit c6f4e73 into main Dec 7, 2022
@joellabes
Copy link
Contributor Author

I'll be curious if the number of checklist items is manageable or overwhelming.

I removed the MAY elements but yeah it's still beefy. Hoping that as a one-off it's not too arduous

we may also want different PR templates for internal script changes vs. listing of packages.

Excellent point!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants