Skip to content

Commit 60c3fdc

Browse files
committed
more issues templates updates
1 parent a5b546c commit 60c3fdc

File tree

1 file changed

+42
-28
lines changed

1 file changed

+42
-28
lines changed

.github/ISSUE_TEMPLATE/issues.md

+42-28
Original file line numberDiff line numberDiff line change
@@ -9,41 +9,51 @@ assignees: ''
99

1010
** DO NOT IGNORE **
1111

12-
READ THESE INSTRUCTIONS FULLY. If you have not submitted a GitHub Issue to lmfit before, read [this](https://github.com/lmfit/lmfit-py/blob/master/.github/CONTRIBUTING.md) first.
13-
14-
***DO NOT USE GitHub Issues for questions, it is only for bug reports***
15-
16-
Issues here should be concerned with errors or problems in the lmfit code. There are other places to get support and help with using lmfit or to discuss ideas about the library.
17-
18-
If you **think** something is an Issue, it probably is not an Issue. If the behavior you
19-
want to report involves a fit that runs to completion without raising an exception but
20-
that gives a result that you think is incorrect, that is almost certainly not an Issue.
21-
22-
Use the [mailing list](https://groups.google.com/group/lmfit-py) or [GitHub discussions
23-
page](https://github.com/lmfit/lmfit-py/discussions) for questions about lmfit or things
24-
you think might be problems. We don't feel obligated to spend our free time helping
25-
people who do not respect our chosen work processes, so if you ignore this advice and post
26-
a question as a GitHub Issue anyway, it is quite likely that your Issue will be closed and
27-
not answered. If you have any doubt at all, do NOT submit an Issue.
28-
29-
To submit an Issue, you MUST provide ALL of the following information. If you delete any
30-
of these sections, your Issue may be closed. If you think one of the sections does not
31-
apply to your Issue, state that explicitly. We will probably disagree with you and insist
32-
that you provide that information. If we have to ask for it twice, we will expect it to be
33-
correct and prompt.
12+
Please Read These Instructions Fully
13+
If you have not submitted a GitHub Issue to lmfit before,
14+
read [this](https://github.com/lmfit/lmfit-py/blob/master/.github/CONTRIBUTING.md) first.
15+
16+
***DO NOT USE GitHub Issues for questions. It is used for (and only for) bug reports***
17+
18+
Issues here should be concerned with errors or problems in the lmfit
19+
code. There are other places to get support and help with using lmfit
20+
or to discuss ideas about the library. Use the [mailing
21+
list](https://groups.google.com/group/lmfit-py) or [GitHub discussions
22+
page](https://github.com/lmfit/lmfit-py/discussions) for questions
23+
about lmfit or things you think might be problems.
24+
25+
26+
If you **think** something is an Issue, it probably is not an
27+
Issue. If the behavior you want to report involves a fit that runs to
28+
completion without raising an exception but that gives a result that
29+
you think is incorrect, that is almost certainly NOT an Issue, though
30+
it may be worth discussing. We do not feel obligated to spend our
31+
free time helping people who do not respect our chosen work processes,
32+
so if you ignore this advice and start with an Issue anyway, it is
33+
quite likely that your Issue will be closed and not answered. If you
34+
have any doubt at all, start a Discussion rather than an Issue.
35+
36+
To submit an Issue, you MUST provide ALL of the following information.
37+
If you delete any of these sections, your Issue may be closed. If you
38+
think one of the sections does not apply to your Issue, explicitly
39+
state that. We will probably disagree with you and have to ask you to
40+
provide that information. If we have to ask for it twice, we will
41+
expect it to be correct and prompt, and may not be willing to help.
3442

3543
** Description **
36-
Provide a short description of the issue, describe the expected outcome, and give the actual result
44+
Provide a short description of the issue, describe the expected
45+
outcome, and give the actual result, including fit report if
46+
available.
3747

3848
** A Minimal, Complete, and Verifiable example **
39-
See, for example, https://stackoverflow.com/help/mcve on how to do this
49+
See https://stackoverflow.com/help/mcve on how to do
50+
this. If we cannot run your code, it is not "complete".
4051

4152
** Fit report: **
42-
Paste the *full* fit report here
53+
Paste the *full* fit report here
4354

4455
** Error message: **
45-
If any, paste the *full* error message inside a code block (starting from line Traceback)
46-
56+
If any, paste the *full* error message inside a code block (starting from line Traceback)
4757

4858

4959
** Version information: **
@@ -55,4 +65,8 @@ print(f"Python: {sys.version}\n\nlmfit: {lmfit.__version__}, scipy: {scipy.__ver
5565
```
5666

5767
** Link(s): **
58-
If you started a discussion on the lmfit mailing list, discussion page, or Stack Overflow, please provide the relevant link(s)
68+
69+
If there is a related discussion on the lmfit mailing list or
70+
Discussion page, please provide the relevant link(s). If there is not
71+
a discussion on the lmfit mailing list or Discussion page, explain why
72+
not.

0 commit comments

Comments
 (0)