Skip to content

Commit

Permalink
Improved Issue Template (#2609)
Browse files Browse the repository at this point in the history
  • Loading branch information
Progi1984 committed May 15, 2024
1 parent 8b891bb commit 2daa50c
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 78 deletions.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: 🐛 Bug Report
description: Create a report to help improve PHPWord
labels: [ "Bug Report" ]
body:
- type: markdown
attributes:
value: |
### ❗️ Read this before submitting your bug report:
- **Write in English/French.** Reports in all other languages will be closed.
- **Provide as much detail as possible**
- Attachments : Error logs, Screenshots, Document files (generated and expected).
- If the issue cannot be reproduced, it cannot be fixed.
- type: textarea
id: what-happened
attributes:
label: Describe the bug and add attachments
description: What went wrong? If possible, add screenshots, error logs, document files (generated and expected) or screen recordings to help explain your problem.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: steps-reproduce
attributes:
label: Steps to reproduce
description: Please provide a code sample that reproduces the issue.
placeholder: |
```php
<?php
require __DIR__ . '/vendor/autoload.php';
$phpWord = new \PhpOffice\PhpWord\PhpWord();
$section = $phpWord->addSection();
$section->...
```
validations:
required: true
- type: input
id: phpword-version
attributes:
label: PHPWord version(s) where the bug happened
placeholder: "e.g., 1.2.0 or master"
validations:
required: true
- type: input
id: php-version
attributes:
label: PHP version(s) where the bug happened
placeholder: "e.g., 7.1 or 8.2"
validations:
required: true
- type: checkboxes
attributes:
label: Priority
description: Funded tickets have a higher priority.
options:
- label: I want to crowdfund the bug fix (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
required: false
- label: I want to pay the bug fix and fund a maintainer for that. (Contact @Progi1984)
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 💡 Feature request
description: Suggest an idea for this project
labels: [ "Change Request" ]
body:
- type: markdown
attributes:
value: |
### ❗️ Read this before submitting your bug report:
- **Write in English/French.** Reports in all other languages will be closed.
- **Provide as much detail as possible**
- Attachments : Error logs, Screenshots, Document files (generated and expected).
- If the issue cannot be reproduced, it cannot be fixed.
- type: textarea
id: problem
attributes:
label: Describe the problem
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Describe the expected behavior
description: A clear and concise description of what you expected to happen. If possible, add screenshots, document files (expected).
validations:
required: true
- type: checkboxes
attributes:
label: Priority
description: Funded tickets have a higher priority.
options:
- label: I want to crowdfund the feature (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer.
required: false
- label: I want to pay the feature and fund a maintainer for that. (Contact @Progi1984)
required: false
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/how-to-use.md

This file was deleted.

7 changes: 4 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Fixes # (issue)

### Checklist:

- [ ] I have run `composer run-script check --timeout=0` and no errors were reported
- [ ] The new code is covered by unit tests (check build/coverage for coverage report)
- [ ] I have updated the documentation to describe the changes
- [ ] My CI is :green_circle:
- [ ] I have covered by unit tests my new code (check build/coverage for coverage report)
- [ ] I have updated the [documentation](https://github.com/PHPOffice/PHPWord/tree/master/docs) to describe the changes
- [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/2.x/2.0.0.md)
3 changes: 2 additions & 1 deletion docs/changes/2.x/2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
- 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)
- 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)
- 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)
- 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)
- 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)
- Improved Issue Template by [@Progi1984](https://github.com/Progi1984) in [#2609](https://github.com/PHPOffice/PHPWord/pull/2609)

### BC Breaks

0 comments on commit 2daa50c

Please sign in to comment.