From 4b7208a8efba11c19cbb80b27037f0e03b4a2332 Mon Sep 17 00:00:00 2001 From: Oscar Dowson Date: Thu, 14 Jun 2018 13:12:51 +1200 Subject: [PATCH] Upgrade to the new Github issue templates (#1338) --- .github/ISSUE_TEMPLATE.md | 11 ----------- .github/ISSUE_TEMPLATE/bug_report.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 +++++++++++++++++++++ 3 files changed, 38 insertions(+), 11 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index be0d614c186..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ -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 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 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. - -- 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! diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..8a8cf9d4ac3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,17 @@ +--- +name: Bug report +about: Help us track down bugs in JuMP + +--- + +Welcome to JuMP! + +Please read the following before posting a new bug report: + +- 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 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). If you are unsure, you should raise the problem on Discourse first. + +- 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. See https://help.github.com/articles/basic-writing-and-formatting-syntax/ for background on how to format text and code on GitHub issues. + +Thanks for contributing to JuMP! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..956702ebc02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for JuMP + +--- + +Welcome to JuMP! You can use this Github issue to suggest a new feature for JuMP. + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +Thanks for contributing to JuMP!