Skip to content

Commit 0d3e507

Browse files
committed
Fix formatting issues in issue templates
- Fix end-of-file formatting and trailing whitespace as caught by pre-commit hooks
1 parent 88ea159 commit 0d3e507

File tree

4 files changed

+324
-0
lines changed

4 files changed

+324
-0
lines changed
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: input
12+
id: contact
13+
attributes:
14+
label: Contact Details
15+
description: How can we get in touch with you if we need more info?
16+
placeholder: ex. [email protected]
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: what-happened
21+
attributes:
22+
label: What happened?
23+
description: Also tell us, what did you expect to happen?
24+
placeholder: Tell us what you see!
25+
value: "A bug happened!"
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: reproduce
30+
attributes:
31+
label: Steps to Reproduce
32+
description: Tell us how to reproduce this bug
33+
placeholder: |
34+
1. Go to '...'
35+
2. Click on '....'
36+
3. Scroll down to '....'
37+
4. See error
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: version
42+
attributes:
43+
label: Version
44+
description: What version of our software are you running?
45+
options:
46+
- main/latest
47+
- v1.0.0
48+
- v0.9.0
49+
- Other (please specify in additional context)
50+
validations:
51+
required: true
52+
- type: dropdown
53+
id: browsers
54+
attributes:
55+
label: What environment are you using?
56+
description: Select all that apply
57+
multiple: true
58+
options:
59+
- Python 3.8
60+
- Python 3.9
61+
- Python 3.10
62+
- Python 3.11
63+
- Python 3.12
64+
- Docker
65+
- Local development
66+
- Production
67+
- Other (please specify in additional context)
68+
- type: textarea
69+
id: logs
70+
attributes:
71+
label: Relevant log output
72+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
73+
render: shell
74+
- type: checkboxes
75+
id: terms
76+
attributes:
77+
label: Code of Conduct
78+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
79+
options:
80+
- label: I agree to follow this project's Code of Conduct
81+
required: true
82+
- type: textarea
83+
id: additional-context
84+
attributes:
85+
label: Additional Context
86+
description: Add any other context about the problem here, including screenshots if applicable.
87+
validations:
88+
required: false

.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: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/your-username/pia-mcp-local/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/your-username/pia-mcp-local/blob/main/README.md
8+
about: Check out the project documentation
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
name: Enhancement/Data Request
2+
description: Suggest an enhancement or request new data features
3+
title: "[Enhancement]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for suggesting an enhancement! Please provide as much detail as possible to help us understand your request.
11+
- type: input
12+
id: contact
13+
attributes:
14+
label: Contact Details
15+
description: How can we get in touch with you if we need more info?
16+
placeholder: ex. [email protected]
17+
validations:
18+
required: false
19+
- type: dropdown
20+
id: request-type
21+
attributes:
22+
label: Request Type
23+
description: What type of enhancement are you requesting?
24+
options:
25+
- New Feature
26+
- Data Source Addition
27+
- API Enhancement
28+
- Performance Improvement
29+
- User Interface Improvement
30+
- Documentation Enhancement
31+
- Integration Request
32+
- Other
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: feature-description
37+
attributes:
38+
label: Feature Description
39+
description: Describe the enhancement or data request in detail
40+
placeholder: |
41+
What would you like to see added or improved?
42+
Be as specific as possible about the functionality you're requesting.
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: problem-statement
47+
attributes:
48+
label: Problem Statement
49+
description: What problem does this enhancement solve?
50+
placeholder: |
51+
- What challenge are you currently facing?
52+
- How would this enhancement help you or other users?
53+
- What are the current limitations?
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: proposed-solution
58+
attributes:
59+
label: Proposed Solution
60+
description: How do you envision this being implemented?
61+
placeholder: |
62+
- How should this feature work?
63+
- What should the user experience be like?
64+
- Any specific implementation details you have in mind?
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: alternatives
69+
attributes:
70+
label: Alternatives Considered
71+
description: What alternative solutions have you considered?
72+
placeholder: |
73+
- Are there workarounds you're currently using?
74+
- Other tools or approaches you've tried?
75+
- Why are those alternatives insufficient?
76+
validations:
77+
required: false
78+
- type: textarea
79+
id: data-sources
80+
attributes:
81+
label: Data Sources (if applicable)
82+
description: If this is a data request, please specify the data sources
83+
placeholder: |
84+
- What data sources would you like to see supported?
85+
- Are there specific APIs or datasets you need access to?
86+
- Do you have access to the data source or API keys?
87+
- Any specific data formats or schemas?
88+
validations:
89+
required: false
90+
- type: dropdown
91+
id: priority
92+
attributes:
93+
label: Priority Level
94+
description: How important is this enhancement to you?
95+
options:
96+
- Low - Nice to have
97+
- Medium - Would be helpful
98+
- High - Important for my use case
99+
- Critical - Blocking my work
100+
validations:
101+
required: true
102+
- type: dropdown
103+
id: user-impact
104+
attributes:
105+
label: Expected User Impact
106+
description: How many users would benefit from this enhancement?
107+
options:
108+
- Just me
109+
- Small group (< 10 users)
110+
- Medium group (10-100 users)
111+
- Large group (100+ users)
112+
- All users
113+
- Not sure
114+
validations:
115+
required: true
116+
- type: textarea
117+
id: implementation-help
118+
attributes:
119+
label: Implementation Assistance
120+
description: Are you willing and able to help with implementation?
121+
placeholder: |
122+
- Can you contribute code, testing, or documentation?
123+
- Do you have expertise in relevant areas?
124+
- What kind of support would you need?
125+
validations:
126+
required: false
127+
- type: textarea
128+
id: additional-context
129+
attributes:
130+
label: Additional Context
131+
description: Any other information that would be helpful
132+
placeholder: |
133+
- Links to relevant documentation, examples, or specifications
134+
- Screenshots or mockups if applicable
135+
- Any other relevant details
136+
validations:
137+
required: false
138+
- type: checkboxes
139+
id: checklist
140+
attributes:
141+
label: Pre-submission Checklist
142+
description: Please confirm you've done the following
143+
options:
144+
- label: I have searched existing issues for similar requests
145+
- label: I have provided a clear description of the problem and solution
146+
- label: I have considered the impact on other users
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Question
2+
description: Ask a question about the project
3+
title: "[Question]: "
4+
labels: ["question"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for your interest in the project! Please provide as much detail as possible to help us understand your question.
11+
- type: input
12+
id: contact
13+
attributes:
14+
label: Contact Details
15+
description: How can we get in touch with you if we need more info?
16+
placeholder: ex. [email protected]
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: question
21+
attributes:
22+
label: Your Question
23+
description: What would you like to know?
24+
placeholder: Please describe your question in detail...
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: context
29+
attributes:
30+
label: Context
31+
description: Please provide any relevant context about what you're trying to accomplish
32+
placeholder: |
33+
- What are you trying to achieve?
34+
- What have you already tried?
35+
- Any relevant documentation you've already consulted?
36+
validations:
37+
required: false
38+
- type: dropdown
39+
id: category
40+
attributes:
41+
label: Question Category
42+
description: What type of question is this?
43+
options:
44+
- Installation/Setup
45+
- Usage/How-to
46+
- Configuration
47+
- API/Integration
48+
- Performance
49+
- Troubleshooting
50+
- Best Practices
51+
- Other
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: environment
56+
attributes:
57+
label: Environment Details
58+
description: Please provide details about your environment if relevant
59+
placeholder: |
60+
- Operating System:
61+
- Python Version:
62+
- Package Version:
63+
- Other relevant details:
64+
render: markdown
65+
validations:
66+
required: false
67+
- type: textarea
68+
id: additional-info
69+
attributes:
70+
label: Additional Information
71+
description: Any other information that might be helpful
72+
validations:
73+
required: false
74+
- type: checkboxes
75+
id: searched
76+
attributes:
77+
label: Pre-submission Checklist
78+
description: Please confirm you've done the following
79+
options:
80+
- label: I have searched existing issues and discussions
81+
- label: I have consulted the documentation
82+
- label: I have provided sufficient context for my question

0 commit comments

Comments
 (0)