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

Add feature request issue template #17382

Merged
merged 2 commits into from May 22, 2018

Conversation

Projects
None yet
1 participant
@rsese
Member

rsese commented May 22, 2018

Requirements

  • Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • All new code requires tests to ensure against regressions

Description of the Change

Adds a new feature request issue template and uses the current issue template as the bug report issue template to take advantage of the new issue template chooser:

https://blog.github.com/2018-05-02-issue-template-improvements/

Alternate Designs

Could leave things as is but we did find the current issue template is more bug report focused which caused some folks to delete it and leave a 1 or 2 sentence feature request. Also, a separate feature request specific template should hopefully encourage more detailed feature requests.

Why Should This Be In Core?

Needs to be so it shows up in the issue template chooser.

Benefits

As mentioned above, a more feature request focused issue template will hopefully encourage people to describe why they want something in addition to encouraging them to look at Atom's customizability in case the feature can be satisfied without changes to Atom.

Possible Drawbacks

It's possible that the extra friction for feature requests might discourage someone from making a feature request, but it's helpful for us to have more information about the what/why/alternatives considered.

Verification Process

After merging:

  1. Create a new issue and make sure the template chooser shows.
  2. Check that the bug report issue template is the current default issue template.
  3. Check that the feature request issue template is the one being added here.

Applicable Issues

n/a

rsese added some commits May 22, 2018

@rsese rsese merged commit 6a5acd9 into master May 22, 2018

3 checks passed

ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@rsese rsese deleted the rsese-add-issue-templates branch May 22, 2018

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