Skip to content

Commit 0a107aa

Browse files
marko-stanojevicmarko-stanojevic
authored
Merge pull request #74 from WarehouseFinds/feature/issue_template
Add issue templates for bug reports, documentation improvements, and feature requests
2 parents 8c80df6 + 812da47 commit 0a107aa

5 files changed

Lines changed: 236 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report this bug! Please fill out the information below to help us investigate.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Run command '...'
27+
2. With parameters '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: Describe the expected behavior
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened?
46+
placeholder: Describe the actual behavior (include error messages if applicable)
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: Environment Information
54+
description: Please provide details about your environment
55+
placeholder: |
56+
- Module Version: [e.g., 1.0.0]
57+
- PowerShell Version: [Run `$PSVersionTable.PSVersion`]
58+
- Operating System: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
59+
- PowerShell Edition: [Desktop or Core]
60+
render: markdown
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: code
66+
attributes:
67+
label: Code Sample
68+
description: Provide a minimal code sample that reproduces the issue
69+
placeholder: |
70+
```powershell
71+
# Your code here
72+
```
73+
render: powershell
74+
75+
- type: textarea
76+
id: logs
77+
attributes:
78+
label: Error Messages / Logs
79+
description: Provide any error messages or relevant log output
80+
placeholder: Paste error messages or logs here
81+
render: shell
82+
83+
- type: textarea
84+
id: additional
85+
attributes:
86+
label: Additional Context
87+
description: Add any other context about the problem here (screenshots, related issues, etc.)

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Questions & Discussions
4+
url: https://github.com/YourUsername/PSScriptModule/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: Security Issues
7+
url: https://github.com/YourUsername/PSScriptModule/security/advisories/new
8+
about: Report security vulnerabilities privately

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Documentation Improvement
2+
description: Suggest improvements to documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation!
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation needs improvement?
16+
options:
17+
- Function help (comment-based or markdown)
18+
- README.md
19+
- CONTRIBUTING.md
20+
- Code comments
21+
- Examples
22+
- Other
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: location
28+
attributes:
29+
label: Location
30+
description: Where is the documentation issue located?
31+
placeholder: |
32+
- File/Function: [e.g., Get-PSScriptModuleInfo]
33+
- Section: [e.g., EXAMPLES]
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: issue
39+
attributes:
40+
label: Issue Description
41+
description: What is wrong or missing in the current documentation?
42+
placeholder: Describe the documentation issue
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: suggestion
48+
attributes:
49+
label: Suggested Improvement
50+
description: How would you improve the documentation?
51+
placeholder: Provide your suggested changes or additions
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: additional
57+
attributes:
58+
label: Additional Context
59+
description: Add any other context or examples

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Feature Summary
15+
description: A brief description of the feature you'd like to see
16+
placeholder: What feature would you like to add?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: problem
22+
attributes:
23+
label: Problem Statement
24+
description: What problem does this feature solve?
25+
placeholder: Describe the problem or limitation you're facing
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Proposed Solution
33+
description: How would you like this feature to work?
34+
placeholder: Describe your ideal solution
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: example
40+
attributes:
41+
label: Usage Example
42+
description: Provide an example of how this feature would be used
43+
placeholder: |
44+
```powershell
45+
# Example usage
46+
Get-Something -NewParameter Value
47+
```
48+
render: powershell
49+
50+
- type: textarea
51+
id: alternatives
52+
attributes:
53+
label: Alternatives Considered
54+
description: What alternative solutions or workarounds have you considered?
55+
placeholder: Describe any alternative approaches
56+
57+
- type: dropdown
58+
id: breaking
59+
attributes:
60+
label: Breaking Change
61+
description: Would this be a breaking change?
62+
options:
63+
- "No"
64+
- "Yes"
65+
- "Not sure"
66+
validations:
67+
required: true
68+
69+
- type: checkboxes
70+
id: contribution
71+
attributes:
72+
label: Contribution
73+
description: Are you willing to contribute to this feature?
74+
options:
75+
- label: I am willing to submit a pull request for this feature
76+
77+
- type: textarea
78+
id: additional
79+
attributes:
80+
label: Additional Context
81+
description: Add any other context, screenshots, or references about the feature request

‎.github/workflows/powershell-build-module.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ jobs:
128128
git fetch --tags
129129
$previousTag = git tag --sort=-v:refname |
130130
Where-Object { $_ -match '^v?\d+\.\d+\.\d+' } |
131-
Select-Object -First 1
131+
Select-Object -Skip 1 -First 1
132132
$uri = "https://api.github.com/repos/${{ github.repository }}/releases/generate-notes"
133133
134134
$body = @{

0 commit comments

Comments
 (0)