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

πŸ“ Provide separate pull request templates based on the type of change being contributed #18066

Merged
merged 1 commit into from Sep 18, 2018

Conversation

Projects
None yet
3 participants
@jasonrudolph
Member

jasonrudolph commented Sep 17, 2018

Requirements for Contributing Documentation

Description of the Change

Pull request templates

Currently, Atom has a one-size-fits-all pull request template. Whether you're fixing a typo in a markdown file, adding a new feature, fixing a bug, or improving performance, we ask the contributor to explain why the change should be part of atom/atom, describe alternate designs, etc. Because some of those questions aren't applicable to some types of changes, we frequently see either A) the contributor having to answer questions that aren't applicable to their change, or B) the contributor deleting parts of the template.

In order to better respect the contributor's time, and to increase the utility of the template in helping the contributor explain their change, and to increase the utility of the template in helping maintainers and community members understand and review the change, this pull request provides separate templates based on the type of change being contributed. πŸ‘©β€πŸ’»:atom:πŸ‘¨β€πŸ’»

CONTRIBUTING.md

Because CONTRIBUTING.md currently references the one-size-fits-all pull request template, this pull request also updates the relevant section of CONTRIBUTING.md. The updated section attempts to provide context for the goals of our pull request requirements, and it distills the actual pull request requirements into three bullets. 1️⃣2️⃣3οΈβƒ£πŸ˜…

Contributor experience

For repositories with multiple issue templates, github.com presents a handy UI for helping the contributor choose the appropriate template. Presently, there is no equivalent UI for repositories with multiple pull request templates. Therefore, we need to help the user find the right pull request template for their change. The top-level PULL_REQUEST_TEMPLATE.md will serve this purpose:

top-level-pull-request-template-screenshot

I dislike that this requires the contributor to go fetch the template on their own and paste it in. But, I love that everything is visible without scrolling; that's an improvement over the current template. πŸ˜‡

@jasonrudolph jasonrudolph requested a review from lee-dohm Sep 17, 2018

- πŸ› Are you fixing a bug? Copy the template from https://bit.ly/atom-bugfix
- πŸ“ˆ Are you improving performance? Copy the template from https://bit.ly/atom-perf
- πŸ“ Are you updating documentation? Copy the template from https://bit.ly/atom-docs
- πŸ’» Are you changing functionality? Copy the template from https://bit.ly/atom-behavior

This comment has been minimized.

@jasonrudolph

jasonrudolph Sep 17, 2018

Member

Note: These https://bit.ly links assume that the templates exist on Atom's master branch. Therefore, these links result in a 404 right now, but they'll work correctly once this PR is merged to master.

@jasonrudolph

jasonrudolph Sep 17, 2018

Member

Note: These https://bit.ly links assume that the templates exist on Atom's master branch. Therefore, these links result in a 404 right now, but they'll work correctly once this PR is merged to master.

@jasonrudolph

This comment has been minimized.

Show comment
Hide comment
@jasonrudolph

jasonrudolph Sep 17, 2018

Member

The AppVeyor build is failing in a way that seems unrelated to this pull request. πŸ˜•

Member

jasonrudolph commented Sep 17, 2018

The AppVeyor build is failing in a way that seems unrelated to this pull request. πŸ˜•

@jasonrudolph jasonrudolph merged commit cc4f368 into master Sep 18, 2018

3 checks passed

Atom Pull Requests #20180917.1 succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jasonrudolph jasonrudolph deleted the contextualize-pull-request-templates branch Sep 18, 2018

@BerkhanBerkdemir

This comment has been minimized.

Show comment
Hide comment
@BerkhanBerkdemir

BerkhanBerkdemir Sep 30, 2018

Hey @jasonrudolph,

Can I ask a question about this PR? Why don't you add templates instead of shortened links under .github folder? For example,

<!-- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md -->
---
name: Feature request
about: Suggest an idea for this project
---
Lorem ipsum dolor sit amet
<!-- .github/ISSUE_TEMPLATE/PERFORMANCE.md -->
---
name: Performance improve
about: Are you improving performance?
---
Lorem ipsum dolor sit amet

Therefore, contributors will only select which issue template important for them (like you do for bug and feature report). Also, I'd like to create an PR about that.

Thank you.

BerkhanBerkdemir commented Sep 30, 2018

Hey @jasonrudolph,

Can I ask a question about this PR? Why don't you add templates instead of shortened links under .github folder? For example,

<!-- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md -->
---
name: Feature request
about: Suggest an idea for this project
---
Lorem ipsum dolor sit amet
<!-- .github/ISSUE_TEMPLATE/PERFORMANCE.md -->
---
name: Performance improve
about: Are you improving performance?
---
Lorem ipsum dolor sit amet

Therefore, contributors will only select which issue template important for them (like you do for bug and feature report). Also, I'd like to create an PR about that.

Thank you.

@Arcanemagus

This comment has been minimized.

Show comment
Hide comment
@Arcanemagus

Arcanemagus Oct 1, 2018

Contributor

This PR is about Pull Requests, not Issues. Unfortunately GitHub currently has no UI for selecting a PR template like there is for Issues.

Contributor

Arcanemagus commented Oct 1, 2018

This PR is about Pull Requests, not Issues. Unfortunately GitHub currently has no UI for selecting a PR template like there is for Issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment