From c0b667e93a8b7720b46074591cd5aaa41b38e59e Mon Sep 17 00:00:00 2001 From: Miles Lubin Date: Sun, 10 Jun 2018 15:46:04 -0400 Subject: [PATCH] tweaks to the issue template (#1336) * tweaks to the issue template * typo fix --- .github/ISSUE_TEMPLATE.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 9d0913eb387..be0d614c186 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,15 +1,11 @@ -If you have a question or are unsure if the behavior you're experiencing is a bug, -please search or post to our Discourse site: https://discourse.julialang.org/c/domain/opt. We use -the GitHub issue tracker for bug reports and feature requests only. +Welcome! The JuMP developers use the GitHub issue tracker for bug reports and feature requests only. Please read the following before posting a new issue: -If the bug you're experiencing is solver-specific (e.g., it only happens when you use Gurobi), -the issue is best raised at the relevant solver-wrapper repository (e.g., [Gurobi.jl](https://github.com/JuliaOpt/Gurobi.jl)). If you are -unsure, you should raise the problem on Discourse. +- If you have a question or are unsure if the behavior you're experiencing is a bug, please search or post to our Discourse site: https://discourse.julialang.org/c/domain/opt. Questions posted to Discourse have broader visibility and are likely to be answered more quickly than issues filed here. -If you're reasonably sure that the behavior is a bug, and it relates to JuMP, this is the right place. -Be sure to include as much relevant information as possible, including a [minimal reproducible example](https://stackoverflow.com/help/mcve). +- If you're experiencing a bug that is solver-specific (e.g., it only happens when you use Gurobi), the issue is best raised at the relevant solver-wrapper repository (e.g., [Gurobi.jl](https://github.com/JuliaOpt/Gurobi.jl)). If you are unsure, you should raise the problem on Discourse first. -Alternatively, if you have a feature request for JuMP, this is also the right place. Just make it clear -by making the title of your issue `Feature Request: my cool new feature`. +- If you are reasonably confident your issue is a bug in JuMP, this is the right place. Be sure to include as much relevant information as possible, including a [minimal reproducible example](https://stackoverflow.com/help/mcve). See https://help.github.com/articles/basic-writing-and-formatting-syntax/ for background on how to format text and code on GitHub issues. + +- If you have a feature request for JuMP, this is also the right place. Just make it clear by making the title of your issue `Feature Request: my cool new feature`. Thanks for contributing to JuMP!