Skip to content

Commit d6b0977

Browse files
committed
Add issue templates for bug reports, feature requests, and usage questions
1 parent fe531ca commit d6b0977

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help improve PHPWord
4+
labels: Bug Report
5+
6+
---
7+
8+
### Describe the Bug
9+
10+
A clear and concise description of what the bug is.
11+
12+
### Steps to Reproduce
13+
14+
Please provide a code sample that reproduces the issue.
15+
16+
```php
17+
<?php
18+
require __DIR__ . '/vendor/autoload.php';
19+
20+
$phpWord = new \PhpOffice\PhpWord\PhpWord();
21+
$section = $phpWord->addSection();
22+
$section->...
23+
```
24+
25+
### Expected Behavior
26+
27+
A clear and concise description of what you expected to happen.
28+
29+
### Current Behavior
30+
31+
What is the current behavior?
32+
33+
### Context
34+
35+
Please fill in your environment information:
36+
37+
- PHP Version:
38+
- PHPWord Version:
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: Change Request
5+
6+
---
7+
8+
### Is your feature request related to a problem? Please describe.
9+
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
### Describe the solution you'd like
13+
14+
A clear and concise description of what you want to happen.
15+
16+
### Describe alternatives you've considered
17+
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
### Additional context
21+
22+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/how-to-use.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: How to Use PHPWord
3+
about: Find out how to use PHPWord
4+
labels: WontFix
5+
6+
---
7+
8+
***Please do not use the issue tracker to ask how to use PHPWord.***
9+
10+
Documentation is available on [Read the Docs](https://phpword.readthedocs.io/en/latest/).
11+
12+
Sample code is in the [`/samples/` directory](https://github.com/PHPOffice/PHPWord/tree/develop/samples).
13+
14+
Usage questions belong on [Stack Overflow](https://stackoverflow.com/questions/tagged/phpword).

0 commit comments

Comments
 (0)