Skip to content

Commit da90bf1

Browse files
authored
Update issue templates
1 parent b70da25 commit da90bf1

File tree

3 files changed

+50
-88
lines changed

3 files changed

+50
-88
lines changed
Lines changed: 21 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,25 @@
1-
name: 🐛 Bug Report
2-
description: Create a report to help us reproduce and fix the bug
1+
---
2+
name: "\U0001F41B Bug Report"
3+
about: Create a report to help us reproduce and fix the bug
4+
title: ''
5+
labels: ''
6+
assignees: ''
37

4-
body:
5-
- type: textarea
6-
attributes:
7-
label: 🐛 Describe the bug
8-
description: |
9-
Please provide a clear and concise description of what the bug is.
8+
---
109

11-
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc. For example:
10+
**Describe the bug**
11+
Please provide a clear and concise description of what the bug is.
1212

13-
```python
14-
# All necessary imports at the beginning
15-
import pandas as pd
16-
from mostlyai import qa
13+
**To Reproduce**
14+
Code to reproduce the behavior:
15+
```
16+
# All necessary imports at the beginning
17+
import pandas as pd
18+
from mostlyai import qa
19+
# A succinct reproducing example trimmed down to the essential parts:
20+
df = pd.DataFrame({'x': [1, 2, 3]})
21+
qa.report(syn_tgt_df=df, trn_tgt_df=df)
22+
```
1723

18-
# A succinct reproducing example trimmed down to the essential parts:
19-
df = pd.DataFrame({'x': [1, 2, 3]}
20-
qa.report(syn_tgt_df=df, trn_tgt_df=df)
21-
```
22-
23-
Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
24-
placeholder: |
25-
A clear and concise description of what the bug is.
26-
27-
```python
28-
# Sample code to reproduce the problem
29-
```
30-
31-
```
32-
The error message you got, with the full traceback.
33-
```
34-
validations:
35-
required: true
36-
- type: textarea
37-
attributes:
38-
label: Versions
39-
description: |
40-
Please run the following and paste the output below.
41-
```sh
42-
- poetry show
43-
```
44-
validations:
45-
required: true
46-
- type: markdown
47-
attributes:
48-
value: >
49-
Thanks for contributing 🎉!
24+
**Expected behavior**
25+
A clear and concise description of what you expected to happen.
Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
name: 📚 Documentation
2-
description: Report an issue related to our documentation.
1+
---
2+
name: " 0x0001F4DA Documentation"
3+
about: Report an issue related to our documentation.
4+
title: ''
5+
labels: ''
6+
assignees: ''
37

4-
body:
5-
- type: textarea
6-
attributes:
7-
label: 📚 The doc issue
8-
description: >
9-
A clear and concise description of what content in our documentation is an issue.
10-
validations:
11-
required: true
12-
- type: textarea
13-
attributes:
14-
label: Suggest a potential alternative/fix
15-
description: >
16-
Tell us how we could improve the documentation in this regard.
17-
- type: markdown
18-
attributes:
19-
value: >
20-
Thanks for contributing 🎉!
8+
---
9+
10+
**Describe the bug**
11+
Please provide a clear and concise description of what the bug is.
12+
13+
**Expected behavior**
14+
A clear and concise description of what you expected to see.
Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
name: 🚀 Feature request
2-
description: Submit a proposal/request for a new feature
1+
---
2+
name: "\U0001F680 Feature Request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
37

4-
body:
5-
- type: textarea
6-
attributes:
7-
label: 🚀 The feature, motivation and pitch
8-
description: >
9-
A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
10-
validations:
11-
required: true
12-
- type: textarea
13-
attributes:
14-
label: Alternatives
15-
description: >
16-
A description of any alternative solutions or features you've considered, if any.
17-
- type: textarea
18-
attributes:
19-
label: Additional context
20-
description: >
21-
Add any other context or screenshots about the feature request.
22-
- type: markdown
23-
attributes:
24-
value: >
25-
Thanks for contributing 🎉!
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is.
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.

0 commit comments

Comments
 (0)