Skip to content

Commit 56dc678

Browse files
authored
Update bug_report.md
1 parent 44850f1 commit 56dc678

1 file changed

Lines changed: 25 additions & 23 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,39 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: 'bug'
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## Describe the bug
11+
1112
A clear and concise description of what the bug is.
1213

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
14+
## To Reproduce
1915

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
16+
Steps to reproduce the behavior or put a short code to reproduce the bug.
17+
18+
### example
19+
20+
```rb
21+
require 'docx'
22+
23+
doc = Docx::Document.new('/path/to/your/docx/file.docx')
2224

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25+
## Something to reproduce the bug here
26+
```
2527

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
28+
## Sample docx file
29+
30+
Put a sample docx file to reproduce the bug reported here to this issue.
31+
32+
## Expected behavior
33+
34+
A clear and concise description of what you expected to happen.
3035

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
36+
## Environment
3637

37-
**Additional context**
38-
Add any other context about the problem here.
38+
- Ruby version: [e.g 2.7.1]
39+
- `docx` gem version: [e.g 0.5.0]
40+
- OS: [e.g. iOS]

0 commit comments

Comments
 (0)