Skip to content

Commit 45c96b6

Browse files
Copilotviniciusvts
Copilot
and
viniciusvts
committed
Add GitHub issue templates for String Morpher project
- Add feature_request.yml with enhancement label - Add bug_report.yml with bug label - Add documentation.yml with documentation label - Add config.yml with blank issues enabled and documentation link - All templates include proper validation rules and required fields Co-authored-by: viniciusvts <[email protected]>
1 parent 9e096a0 commit 45c96b6

4 files changed

Lines changed: 277 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in String Morpher
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug! Please provide as much detail as possible to help us fix it quickly.
10+
11+
- type: textarea
12+
id: bug-description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is
16+
placeholder: When I use SM::method()... I expect... but instead...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Provide a minimal code example to reproduce the issue
25+
placeholder: |
26+
```php
27+
use SSolWEB\StringMorpher\StringMorpher as SM;
28+
29+
$result = SM::make('example')
30+
->method()
31+
->getString();
32+
33+
echo $result; // Outputs: ...
34+
```
35+
render: php
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: expected-behavior
41+
attributes:
42+
label: Expected Behavior
43+
description: What did you expect to happen?
44+
placeholder: I expected the output to be...
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: actual-behavior
50+
attributes:
51+
label: Actual Behavior
52+
description: What actually happened?
53+
placeholder: Instead, the output was...
54+
validations:
55+
required: true
56+
57+
- type: input
58+
id: version
59+
attributes:
60+
label: String Morpher Version
61+
description: Which version of String Morpher are you using?
62+
placeholder: e.g., 1.0.0 (check composer.json or packagist)
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: php-version
68+
attributes:
69+
label: PHP Version
70+
description: Which version of PHP are you running?
71+
placeholder: e.g., 8.1, 8.2, 8.3
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: environment
77+
attributes:
78+
label: Environment Details
79+
description: Any relevant environment information (OS, framework, etc.)
80+
placeholder: |
81+
- OS: Ubuntu 22.04
82+
- Framework: Laravel 10
83+
validations:
84+
required: false
85+
86+
- type: textarea
87+
id: additional-context
88+
attributes:
89+
label: Additional Context
90+
description: Add any other context, screenshots, or error messages
91+
validations:
92+
required: false
93+
94+
- type: checkboxes
95+
id: checklist
96+
attributes:
97+
label: Checklist
98+
description: Please confirm the following
99+
options:
100+
- label: I have read the [Installation](https://ssolweb.github.io/string-morpher/docs/installation/) and [Methods](https://ssolweb.github.io/string-morpher/docs/methods/) documentation
101+
required: true
102+
- label: I have searched for similar issues (open and closed)
103+
required: true
104+
- label: This issue is not already documented
105+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://ssolweb.github.io/string-morpher
5+
about: Read the full documentation for String Morpher

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: 📚 Documentation
2+
description: Report documentation issues or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation! Please describe the issue or suggestion below.
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation issue is this?
16+
options:
17+
- Missing documentation
18+
- Incorrect/outdated documentation
19+
- Typo or grammar issue
20+
- Unclear explanation
21+
- Missing example
22+
- Broken link
23+
- Suggestion for improvement
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: doc-location
30+
attributes:
31+
label: Documentation Location
32+
description: Where is this documentation located?
33+
placeholder: e.g., https://ssolweb.github.io/string-morpher/docs/methods/trim/ or README.md
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: issue-description
39+
attributes:
40+
label: Issue Description
41+
description: Clearly describe the documentation issue or what needs improvement
42+
placeholder: The documentation for the trim() method doesn't mention...
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: suggested-change
48+
attributes:
49+
label: Suggested Change or Addition
50+
description: If applicable, suggest how the documentation should be corrected or improved
51+
placeholder: |
52+
I suggest adding:
53+
```php
54+
// Example code
55+
```
56+
Or changing the text to: "..."
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
id: additional-context
62+
attributes:
63+
label: Additional Context
64+
description: Add any other context or screenshots
65+
validations:
66+
required: false
67+
68+
- type: checkboxes
69+
id: contribution
70+
attributes:
71+
label: Contribution
72+
description: Would you be willing to help improve this documentation?
73+
options:
74+
- label: I'm willing to submit a PR to fix/improve this documentation
75+
required: false
76+
77+
- type: checkboxes
78+
id: checklist
79+
attributes:
80+
label: Checklist
81+
options:
82+
- label: I have checked the latest version of the documentation
83+
required: true
84+
- label: I have searched for similar documentation issues
85+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: 🚀 Feature Request
2+
description: Suggest a new feature or enhancement for String Morpher
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest a new feature! Please fill out the information below.
10+
11+
- type: textarea
12+
id: feature-description
13+
attributes:
14+
label: Feature Description
15+
description: A clear and concise description of the feature you'd like to see
16+
placeholder: I would like String Morpher to...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: use-case
22+
attributes:
23+
label: Use Case
24+
description: Describe the problem this feature would solve or the use case it would address
25+
placeholder: This would be useful when...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: proposed-solution
31+
attributes:
32+
label: Proposed Solution
33+
description: How do you envision this feature working?
34+
placeholder: |
35+
Example usage:
36+
```php
37+
$result = SM::make('example')->newMethod();
38+
```
39+
validations:
40+
required: false
41+
42+
- type: dropdown
43+
id: feature-type
44+
attributes:
45+
label: Feature Type
46+
description: What type of feature is this?
47+
options:
48+
- New Transformer (string manipulation method)
49+
- New Mask (formatting method)
50+
- Case Conversion
51+
- API Enhancement
52+
- Other
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: alternatives
58+
attributes:
59+
label: Alternatives Considered
60+
description: Have you considered any alternative solutions or workarounds?
61+
validations:
62+
required: false
63+
64+
- type: checkboxes
65+
id: contribution
66+
attributes:
67+
label: Contribution
68+
description: Would you be willing to contribute this feature?
69+
options:
70+
- label: I'm willing to implement this feature and submit a PR
71+
required: false
72+
73+
- type: checkboxes
74+
id: checklist
75+
attributes:
76+
label: Checklist
77+
description: Please confirm the following
78+
options:
79+
- label: I have read the [documentation](https://ssolweb.github.io/string-morpher)
80+
required: true
81+
- label: I have searched for similar feature requests
82+
required: true

0 commit comments

Comments
 (0)