Skip to content

Commit 25e36ff

Browse files
committed
add bug report issue form
1 parent 121f729 commit 25e36ff

File tree

2 files changed

+74
-13
lines changed

2 files changed

+74
-13
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Bug Report
2+
description: A detailed description of a problem you are experiencing
3+
title: "..."
4+
labels: [bug, triage]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Current Behavior
16+
description: A concise description of what you're experiencing.
17+
validations:
18+
required: false
19+
- type: textarea
20+
attributes:
21+
label: Expected Behavior
22+
description: A concise description of what you expected to happen.
23+
validations:
24+
required: false
25+
- type: textarea
26+
attributes:
27+
label: Steps To Reproduce
28+
description: Steps to reproduce the behavior.
29+
placeholder: |
30+
1. In this environment...
31+
2. With this config...
32+
3. Run '...'
33+
4. See error...
34+
validations:
35+
required: false
36+
- type: textarea
37+
attributes:
38+
label: Environment
39+
description: |
40+
examples:
41+
- **OS**: Ubuntu 20.04
42+
- **Python**: 3.10
43+
- **Browser**: Chrome 92
44+
value: |
45+
- OS:
46+
- Python:
47+
- Browser:
48+
render: markdown
49+
validations:
50+
required: false
51+
- type: textarea
52+
attributes:
53+
label: Anything else?
54+
description: |
55+
Links? References? Anything that will give us more context about the issue you are encountering!
56+
57+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
58+
validations:
59+
required: false

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Django IDOM
22

3-
<a href="https://github.com/idom-team/django-idom/actions?query=workflow%3ATest">
4-
<img alt="Tests" src="https://github.com/idom-team/django-idom/workflows/Test/badge.svg?event=push" />
5-
</a>
6-
<a href="https://pypi.python.org/pypi/django-idom">
7-
<img alt="Version Info" src="https://img.shields.io/pypi/v/idom.svg"/>
8-
</a>
9-
<a href="https://github.com/idom-team/django-idom/blob/main/LICENSE">
10-
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-purple.svg">
11-
</a>
12-
13-
`django-idom` allows you to integrate [IDOM](https://github.com/idom-team/idom) into
14-
Django applications. IDOM is a pure Python library inspired by
15-
[ReactJS](https://reactjs.org/) for creating responsive web interfaces.
3+
<p>
4+
<a href="https://github.com/idom-team/django-idom/actions?query=workflow%3ATest">
5+
<img alt="Tests" src="https://github.com/idom-team/django-idom/workflows/Test/badge.svg?event=push" />
6+
</a>
7+
<a href="https://pypi.python.org/pypi/django-idom">
8+
<img alt="Version Info" src="https://img.shields.io/pypi/v/idom.svg"/>
9+
</a>
10+
<a href="https://github.com/idom-team/django-idom/blob/main/LICENSE">
11+
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-purple.svg">
12+
</a>
13+
</p>
14+
15+
`django-idom` allows Django to integrate with [IDOM](https://github.com/idom-team/idom),
16+
a package inspired by [ReactJS](https://reactjs.org/) for creating responsive web
17+
interfaces in pure Python.
1618

1719
**You can try IDOM now in a Jupyter Notebook:**
1820
<a

0 commit comments

Comments
 (0)