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

Add Issue Templates #1668

Merged
merged 3 commits into from
Jul 13, 2018
Merged

Add Issue Templates #1668

merged 3 commits into from
Jul 13, 2018

Conversation

rigelrozanski
Copy link
Contributor

@rigelrozanski rigelrozanski commented Jul 13, 2018

Two issue templates created:

  • Bug Report
  • Feature Request

Here is an idea of what it will look like https://help.github.com/articles/about-issue-and-pull-request-templates/

@rigelrozanski rigelrozanski added ready-for-review T:Docs Changes and features related to documentation. labels Jul 13, 2018
@rigelrozanski rigelrozanski changed the title Update issue templates Add Issue Template Jul 13, 2018
## Proposed solution
<!--
For Bugs: (if applicable) proposed steps for solution
For Proposals: The Proposal
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it may confuse users if they think they have to propose a solution for bugs in order to file the issue. B/c of that, I think we should tag this as proposals only.

Also, should we add a note saying that proposals will be closed unless there is an actual concrete proposal? (I.e. for large feature requests, there has to be a description of what needs to be implemented, for small feature requests where its a (relatively) simple change this isn't needed)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm going to separate this out into multiple templates to distinguish bug fixes vs. feature requests - should alleviate some of the comments.

Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this to the proposal template Word of Caution: poorly thought-out proposals may be rejected without deliberation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed comments

@rigelrozanski rigelrozanski changed the title Add Issue Template Add Issue Templates Jul 13, 2018
Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

utACK

@codecov
Copy link

codecov bot commented Jul 13, 2018

Codecov Report

Merging #1668 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1668   +/-   ##
=======================================
  Coverage   62.84%   62.84%           
=======================================
  Files         124      124           
  Lines        6992     6992           
=======================================
  Hits         4394     4394           
  Misses       2346     2346           
  Partials      252      252

@rigelrozanski rigelrozanski merged commit 89f4f37 into master Jul 13, 2018
@rigelrozanski rigelrozanski deleted the rigel/issue-template branch July 13, 2018 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants