Skip to content

Update issue templates#1338

Merged
odow merged 9 commits intomasterfrom
odow-patch-1
Jun 14, 2018
Merged

Update issue templates#1338
odow merged 9 commits intomasterfrom
odow-patch-1

Conversation

@odow
Copy link
Copy Markdown
Member

@odow odow commented Jun 10, 2018

Ref Closes #1337

Just had a play following this instructions at https://help.github.com/articles/about-issue-and-pull-request-templates/
We probably need to make a feature request template as well? Done

@mlubin
Copy link
Copy Markdown
Member

mlubin commented Jun 10, 2018

Yes, we should have a feature request template as well if we make this change. Do we want to add an actual usable template for the bug reports in addition to the warnings? (I'm not sure it's needed.)

odow added 3 commits June 11, 2018 08:38
The default Feature request template from Github
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 10, 2018

Codecov Report

Merging #1338 into master will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1338      +/-   ##
==========================================
+ Coverage    89.4%   89.49%   +0.08%     
==========================================
  Files          24       24              
  Lines        3398     3502     +104     
==========================================
+ Hits         3038     3134      +96     
- Misses        360      368       +8
Impacted Files Coverage Δ
src/macros.jl 89.62% <0%> (+0.52%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0b667e...445650a. Read the comment docs.

@odow
Copy link
Copy Markdown
Member Author

odow commented Jun 13, 2018

I've added a template since it is too easy to skim or delete the template text without reading.

@mlubin
Copy link
Copy Markdown
Member

mlubin commented Jun 13, 2018

Adding extra text could make it even more tempting to skim. I'm hesitant about the checklist. It's a bit patronizing and not 100% applicable. There are rare cases where a minimum working example is too hard to make but we might still want to know that someone is experiencing an issue. There are also not always multiple solvers available for a particular problem class. It would make more sense to formulate these as debugging tips rather than a checklist.

@odow
Copy link
Copy Markdown
Member Author

odow commented Jun 13, 2018

I agree with all those points. Maybe we should just try this for a while and see how it goes.


---

Welcome to JuMP! The JuMP developers use the GitHub issue tracker for bug reports and feature requests only. Please read the following before posting a new issue:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Given the split between bug report and feature request, maybe:

"Welcome to JuMP! Please read the following before posting a new bug report:"

Copy link
Copy Markdown
Member

@mlubin mlubin left a comment

Choose a reason for hiding this comment

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

Do we also need to remove the old ISSUE_TEMPLATE.md?

@odow
Copy link
Copy Markdown
Member Author

odow commented Jun 14, 2018

Deleted.

@odow odow merged commit 4b7208a into master Jun 14, 2018
@odow odow deleted the odow-patch-1 branch June 14, 2018 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants