Skip to content

Commit 2daa50c

Browse files
authored
Improved Issue Template (#2609)
1 parent 8b891bb commit 2daa50c

File tree

7 files changed

+106
-78
lines changed

7 files changed

+106
-78
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help improve PHPWord
3+
labels: [ "Bug Report" ]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### ❗️ Read this before submitting your bug report:
9+
- **Write in English/French.** Reports in all other languages will be closed.
10+
- **Provide as much detail as possible**
11+
- Attachments : Error logs, Screenshots, Document files (generated and expected).
12+
- If the issue cannot be reproduced, it cannot be fixed.
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: Describe the bug and add attachments
17+
description: What went wrong? If possible, add screenshots, error logs, document files (generated and expected) or screen recordings to help explain your problem.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: expected-behavior
22+
attributes:
23+
label: Expected behavior
24+
description: A clear and concise description of what you expected to happen.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: steps-reproduce
29+
attributes:
30+
label: Steps to reproduce
31+
description: Please provide a code sample that reproduces the issue.
32+
placeholder: |
33+
```php
34+
<?php
35+
require __DIR__ . '/vendor/autoload.php';
36+
37+
$phpWord = new \PhpOffice\PhpWord\PhpWord();
38+
$section = $phpWord->addSection();
39+
$section->...
40+
```
41+
validations:
42+
required: true
43+
- type: input
44+
id: phpword-version
45+
attributes:
46+
label: PHPWord version(s) where the bug happened
47+
placeholder: "e.g., 1.2.0 or master"
48+
validations:
49+
required: true
50+
- type: input
51+
id: php-version
52+
attributes:
53+
label: PHP version(s) where the bug happened
54+
placeholder: "e.g., 7.1 or 8.2"
55+
validations:
56+
required: true
57+
- type: checkboxes
58+
attributes:
59+
label: Priority
60+
description: Funded tickets have a higher priority.
61+
options:
62+
- label: I want to crowdfund the bug fix (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
63+
required: false
64+
- label: I want to pay the bug fix and fund a maintainer for that. (Contact @Progi1984)
65+
required: false
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: 💡 Feature request
2+
description: Suggest an idea for this project
3+
labels: [ "Change Request" ]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### ❗️ Read this before submitting your bug report:
9+
- **Write in English/French.** Reports in all other languages will be closed.
10+
- **Provide as much detail as possible**
11+
- Attachments : Error logs, Screenshots, Document files (generated and expected).
12+
- If the issue cannot be reproduced, it cannot be fixed.
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Describe the problem
17+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: expected-behavior
22+
attributes:
23+
label: Describe the expected behavior
24+
description: A clear and concise description of what you expected to happen. If possible, add screenshots, document files (expected).
25+
validations:
26+
required: true
27+
- type: checkboxes
28+
attributes:
29+
label: Priority
30+
description: Funded tickets have a higher priority.
31+
options:
32+
- label: I want to crowdfund the feature (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
33+
required: false
34+
- label: I want to pay the feature and fund a maintainer for that. (Contact @Progi1984)
35+
required: false

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

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

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Fixes # (issue)
66

77
### Checklist:
88

9-
- [ ] I have run `composer run-script check --timeout=0` and no errors were reported
10-
- [ ] The new code is covered by unit tests (check build/coverage for coverage report)
11-
- [ ] I have updated the documentation to describe the changes
9+
- [ ] My CI is :green_circle:
10+
- [ ] I have covered by unit tests my new code (check build/coverage for coverage report)
11+
- [ ] I have updated the [documentation](https://github.com/PHPOffice/PHPWord/tree/master/docs) to describe the changes
12+
- [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/2.x/2.0.0.md)

docs/changes/2.x/2.0.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- Bump phpmd/phpmd from 2.14.1 to 2.15.0 by [@dependabot](https://github.com/dependabot) in [#2538](https://github.com/PHPOffice/PHPWord/pull/2538)
2323
- Bump phpunit/phpunit from 9.6.14 to 9.6.15 by [@dependabot](https://github.com/dependabot) in [#2537](https://github.com/PHPOffice/PHPWord/pull/2537)
2424
- Bump symfony/process from 5.4.28 to 5.4.34 by [@dependabot](https://github.com/dependabot) in [#2536](https://github.com/PHPOffice/PHPWord/pull/2536)
25-
- Allow rgb() when converting Html [@oleibman](https://github.com/oleibman) fixing [#2508](https://github.com/PHPOffice/PHPWord/issues/2508) in [#2512](https://github.com/PHPOffice/PHPWord/pull/2512)
25+
- Allow rgb() when converting Html by [@oleibman](https://github.com/oleibman) fixing [#2508](https://github.com/PHPOffice/PHPWord/issues/2508) in [#2512](https://github.com/PHPOffice/PHPWord/pull/2512)
26+
- Improved Issue Template by [@Progi1984](https://github.com/Progi1984) in [#2609](https://github.com/PHPOffice/PHPWord/pull/2609)
2627

2728
### BC Breaks

0 commit comments

Comments
 (0)