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

Improve Github's Pull Request Template file #2515

Merged
merged 1 commit into from
Mar 6, 2018

Conversation

bertocq
Copy link
Collaborator

@bertocq bertocq commented Mar 4, 2018

References

  • Related Issues: None
  • Related Pull Requests: None

Objectives

The actual PR template feels more like bureaucracy than an actual guide
or checklist to help the PR author explain all important thigs that any
reviewer or changelog reader may need to understand.

We'll be moving most of the redundant things (like remembering tests are
needed, or explaning how things where implemented with a clear and
granular commit history) into a Wiki/Doc entry.

For regular contributors there is no need for reminders, we need to
improve new contributors landing with good guides and lowering the bar
for first PR's

Visual Changes (if any)

None

Deployment & Warnings

None

Copy link
Contributor

@MariaCheca MariaCheca left a comment

Choose a reason for hiding this comment

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

Looks good! Simple and concise :)

@bertocq
Copy link
Collaborator Author

bertocq commented Mar 5, 2018

I just remembered we mentioned using Notes title for the Deployment & Warnings section, as it's less "alarming" but it might be less "specific"... but for that we have the section guide text 🤔. An Improvement?

The actual PR template feels more like bureaucracy than an actual guide
or checklist to help the PR author explain all important thigs that any
reviewer or changelog reader may need to understand.

We'll be moving most of the redundant things (like remembering tests are
needed, or explaning how things where implemented with a clear and
granular commit history) into a Wiki/Doc entry.

For regular contributors there is no need for reminders, we need to
improve new contributors landing with good guides and lowering the bar
for first PR's
@bertocq bertocq force-pushed the improve_pull_request_template branch from 3cf0a7e to d0c7bae Compare March 6, 2018 10:05
@bertocq bertocq merged commit 8456b74 into master Mar 6, 2018
@bertocq bertocq deleted the improve_pull_request_template branch March 6, 2018 11:05
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.

None yet

3 participants