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

Update issue templates #1338

Merged
merged 9 commits into from Jun 14, 2018

Conversation

@odow
Copy link
Member

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

This comment has been minimized.

Copy link
Member

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 some commits Jun 10, 2018

Update issue templates
The default Feature request template from Github
@codecov

This comment has been minimized.

Copy link

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

This comment has been minimized.

Copy link
Member Author

commented Jun 13, 2018

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

@mlubin

This comment has been minimized.

Copy link
Member

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

This comment has been minimized.

Copy link
Member Author

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:

This comment has been minimized.

Copy link
@mlubin

mlubin Jun 13, 2018

Member

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

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

odow added some commits Jun 14, 2018

@mlubin

mlubin approved these changes Jun 14, 2018

Copy link
Member

left a comment

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

@odow

This comment has been minimized.

Copy link
Member Author

commented Jun 14, 2018

Deleted.

@mlubin

mlubin approved these changes Jun 14, 2018

@odow odow merged commit 4b7208a into master Jun 14, 2018

5 checks passed

codecov/patch Coverage not affected when comparing c0b667e...445650a
Details
codecov/project 89.49% (+0.08%) compared to c0b667e
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@odow odow deleted the odow-patch-1 branch Jun 14, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.