MilesCranmer commited on
Commit
1d68908
1 Parent(s): 8586ee3

Improve bug report template

Browse files
.github/ISSUE_TEMPLATE/bug_report.md DELETED
@@ -1,34 +0,0 @@
1
- ---
2
- name: Bug report
3
- about: Create a report to help us improve
4
- title: "[BUG] *Summary of bug*"
5
- labels: bug
6
- assignees: MilesCranmer
7
-
8
- ---
9
-
10
- **Describe the bug**
11
- A clear and concise description of what the bug is.
12
-
13
- **Version (please include the following information):**
14
- - OS: [e.g. macOS]
15
- - Julia version [Run `julia --version` in the terminal]
16
- - Python version [Run `python --version` in the terminal]
17
- - Did you install with `pip` or `conda`?
18
- - PySR version [Run `python -c 'import pysr; print(pysr.__version__)'`]
19
- - Does the bug still appear with the latest version of PySR?
20
-
21
- **Configuration**
22
- - What are your PySR settings?
23
- - What dataset are you running on?
24
- - If possible, please share a minimal code example that produces the error.
25
-
26
- **Error message**
27
- Add the error message here, or whatever other information would be useful for debugging.
28
-
29
- If the error is "Couldn't find equation file...", this error indicates something
30
- went wrong with the backend. Please scroll up and copy
31
- the output of Julia, rather than the output of python.
32
-
33
- **Additional context**
34
- Add any other context about the problem here.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
.github/ISSUE_TEMPLATE/bug_report.yml ADDED
@@ -0,0 +1,70 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Bug report
2
+ description: File a bug report
3
+ title: "[BUG]: "
4
+ labels: ["bug"]
5
+ assignees:
6
+ - MilesCranmer
7
+
8
+ body:
9
+ - type: markdown
10
+ attributes:
11
+ value: |
12
+ Thanks for taking the time to fill out this bug report!
13
+ - type: textarea
14
+ id: what-happened
15
+ attributes:
16
+ label: What happened?
17
+ description: Also tell us, what did you expect to happen?
18
+ placeholder: Tell us what you see!
19
+ value: "A bug happened!"
20
+ validations:
21
+ required: true
22
+ - type: input
23
+ id: version
24
+ attributes:
25
+ label: Version
26
+ description: What version of PySR are you running? `python3 -c 'import pysr; print(pysr.__version__)'`. (You might want to check the latest version, in case the issue has already been fixed.)
27
+ validations:
28
+ required: true
29
+ - type: dropdown
30
+ id: os
31
+ attributes:
32
+ label: Operating System
33
+ description: What operating system do you see the issue on?
34
+ multiple: true
35
+ options:
36
+ - Windows
37
+ - macOS
38
+ - Linux
39
+ - type: dropdown
40
+ id: pkg-manager
41
+ attributes:
42
+ label: Package Manager
43
+ description: What package manager are you using to install PySR?
44
+ options:
45
+ - pip
46
+ - conda
47
+ - other (specify below)
48
+ - type: dropdown
49
+ id: display
50
+ attributes:
51
+ label: Interface
52
+ description: How are you running PySR?
53
+ options:
54
+ - Jupyter Notebook
55
+ - IPython Terminal
56
+ - Script
57
+ - Google Colab
58
+ validations:
59
+ required: true
60
+ - type: textarea
61
+ id: logs
62
+ attributes:
63
+ labels: Relevant log output
64
+ description: Please copy and paste any log output or error messages. This will be automatically formatted into code, so no need for backticks.
65
+ render: shell
66
+ - type: textarea
67
+ id: extra
68
+ attributes:
69
+ labels: Extra Info
70
+ description: Please tell us any other information that you think might help. For example, what are your PySR settings? What dataset are you running on? If possible, please share a minimal code example that produces the error.