Skip to content

Commit f0d855e

Browse files
mPokornyETMmPokornyETM
authored
Merge pull request #8 from winccoa-tools-pack/chore/remove-release-workflows
chore(ci): remove generic CI and release workflows; update README
2 parents 0ce7223 + 136f4d4 commit f0d855e

25 files changed

+1306
-31
lines changed

‎.github/DISCUSSIONS.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# GitHub Discussions Guide
2+
3+
Welcome to the community discussions!
4+
5+
## Discussion Categories
6+
7+
**📢 Announcements**
8+
Official project updates, releases, and important notices.
9+
10+
**💡 Ideas**
11+
Feature requests, suggestions, and enhancement proposals.
12+
13+
**🙋‍♀️ Q&A**
14+
Technical support, troubleshooting, and how-to questions.
15+
16+
**🛠️ Show and Tell**
17+
Share your projects, configurations, and success stories.
18+
19+
**🔧 Development**
20+
Development discussions, architecture decisions, and contribution coordination.
21+
22+
**🌐 General**
23+
Community chat and general WinCC OA related discussions.
24+
25+
## Posting Guidelines
26+
27+
### Before You Post
28+
29+
1. Search existing discussions to avoid duplicates
30+
2. Choose the appropriate category
31+
3. Write a clear, descriptive title
32+
4. Include relevant context and environment details
33+
34+
### For Questions
35+
36+
Include your environment details:
37+
38+
- Package Version: (e.g., 1.0.0)
39+
- Node.js Version: (e.g., 18.x)
40+
- npm Version: (e.g., 9.x)
41+
- Operating System: (e.g., Windows 11)
42+
43+
Describe the issue clearly with steps to reproduce.
44+
45+
### For Feature Ideas
46+
47+
- Describe the problem you're trying to solve
48+
- Explain your proposed solution
49+
- Include use cases and examples
50+
- Consider alternatives you've thought about
51+
52+
## Community Guidelines
53+
54+
**Be Respectful**
55+
Treat everyone with kindness and respect.
56+
57+
**Stay On-Topic**
58+
Keep discussions related to the project and library usage.
59+
60+
**Provide Value**
61+
Share knowledge, help others, and give constructive feedback.
62+
63+
**Use Best Practices**
64+
Format code properly, use clear titles, and include context.
65+
66+
## Quick Links
67+
68+
- [Documentation](README.md)
69+
- [Bug Reports](../../issues)
70+
- [Contributing Guide](CONTRIBUTING.md)
71+
72+
Let's build an amazing community!

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
**Describe the bug**
3+
A clear and concise description of what the bug is.
4+
5+
**To Reproduce**
6+
Steps to reproduce the behavior:
7+
8+
1. Go to '...'
9+
2. Click on '...'
10+
3. Scroll down to '...'
11+
4. See error
12+
13+
**Expected behavior**
14+
A clear and concise description of what you expected to happen.
15+
16+
**Screenshots**
17+
If applicable, add screenshots to help explain your problem.
18+
19+
**Environment (please complete the following information):**
20+
21+
- OS: [e.g. Windows 10, Windows 11]
22+
- VS Code Version: [e.g. 1.85.0]
23+
- Extension Version: [e.g. 1.0.0]
24+
- WinCC OA Version: [e.g. 3.21]
25+
26+
**WinCC OA Configuration**
27+
28+
- Number of projects: [e.g. 5]
29+
- Projects location: [e.g. C:\WinCC_OA_Projects]
30+
- pvssInst.conf accessible: [Yes/No]
31+
32+
**Additional context**
33+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
name: 🐛 Bug Report
2+
description: Report a problem with the WinCC OA VS Code Extension
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
projects: []
6+
assignees: []
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for reporting a bug! 🐛
13+
14+
Please provide as much detail as possible to help us reproduce and fix the issue.
15+
16+
- type: dropdown
17+
id: severity
18+
attributes:
19+
label: Severity
20+
description: How severe is this bug?
21+
options:
22+
- Critical (Extension completely unusable)
23+
- High (Major functionality broken)
24+
- Medium (Feature partially broken)
25+
- Low (Minor issue or cosmetic)
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Bug Description
33+
description: A clear and concise description of what the bug is
34+
placeholder: Describe what happened and what you expected to happen
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: steps-to-reproduce
40+
attributes:
41+
label: Steps to Reproduce
42+
description: Steps to reproduce the behavior
43+
placeholder: |
44+
1. Go to '...'
45+
2. Click on '...'
46+
3. Scroll down to '...'
47+
4. See error
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: expected-behavior
53+
attributes:
54+
label: Expected Behavior
55+
description: What you expected to happen
56+
placeholder: Describe what should have happened instead
57+
58+
- type: textarea
59+
id: actual-behavior
60+
attributes:
61+
label: Actual Behavior
62+
description: What actually happened
63+
placeholder: Describe what actually happened
64+
65+
- type: textarea
66+
id: error-logs
67+
attributes:
68+
label: Error Messages/Logs
69+
description: Copy any error messages or relevant log output
70+
placeholder: Paste error messages, stack traces, or log output here
71+
render: text
72+
73+
- type: textarea
74+
id: screenshots
75+
attributes:
76+
label: Screenshots
77+
description: If applicable, add screenshots to help explain your problem
78+
placeholder: You can paste screenshots directly here
79+
80+
- type: input
81+
id: extension-version
82+
attributes:
83+
label: Extension Version
84+
description: What version of the WinCC OA extension are you using?
85+
placeholder: "e.g., 1.0.0"
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: vscode-version
91+
attributes:
92+
label: VS Code Version
93+
description: What version of VS Code are you using?
94+
placeholder: "e.g., 1.94.0"
95+
validations:
96+
required: true
97+
98+
- type: dropdown
99+
id: winccoa-version
100+
attributes:
101+
label: WinCC OA Version
102+
description: Which WinCC OA version are you using?
103+
options:
104+
- "3.21"
105+
- "3.20"
106+
- "3.19"
107+
- "3.18"
108+
- "Multiple versions"
109+
- "Not applicable"
110+
validations:
111+
required: true
112+
113+
- type: dropdown
114+
id: operating-system
115+
attributes:
116+
label: Operating System
117+
description: What operating system are you using?
118+
options:
119+
- Windows 11
120+
- Windows 10
121+
- Windows Server 2022
122+
- Windows Server 2019
123+
- Linux (specify in additional context)
124+
- Other
125+
validations:
126+
required: true
127+
128+
- type: textarea
129+
id: additional-context
130+
attributes:
131+
label: Additional Context
132+
description: Add any other context about the problem here
133+
placeholder: Any additional information that might help us understand the issue
134+
135+
- type: checkboxes
136+
id: terms
137+
attributes:
138+
label: Code of Conduct
139+
description: By submitting this issue, you agree to follow our Code of Conduct
140+
options:
141+
- label: I agree to follow this project's Code of Conduct
142+
required: true

‎.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 Issue
2+
description: Report an issue with documentation or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
projects: []
6+
assignees: []
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for helping improve our documentation! 📚
13+
14+
Please describe the documentation issue or improvement you'd like to suggest.
15+
16+
- type: dropdown
17+
id: doc-type
18+
attributes:
19+
label: Documentation Type
20+
description: What type of documentation is this about?
21+
options:
22+
- README
23+
- API Documentation
24+
- User Guide
25+
- Developer Guide
26+
- Code Comments
27+
- Configuration Examples
28+
- Troubleshooting
29+
- Other
30+
validations:
31+
required: true
32+
33+
- type: dropdown
34+
id: issue-type
35+
attributes:
36+
label: Issue Type
37+
description: What kind of documentation issue is this?
38+
options:
39+
- Missing documentation
40+
- Incorrect information
41+
- Outdated information
42+
- Unclear explanation
43+
- Typo/Grammar
44+
- Broken link
45+
- Missing example
46+
- Improvement suggestion
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: location
52+
attributes:
53+
label: Documentation Location
54+
description: Where is this documentation located?
55+
placeholder: "e.g., README.md, docs/api.md, line 42 of extension.ts"
56+
57+
- type: textarea
58+
id: current-content
59+
attributes:
60+
label: Current Content (if applicable)
61+
description: Quote the current content that needs to be changed
62+
placeholder: Copy the existing text here if applicable
63+
64+
- type: textarea
65+
id: suggested-content
66+
attributes:
67+
label: Suggested Content
68+
description: What should the documentation say instead?
69+
placeholder: Provide your suggested improvement or new content
70+
71+
- type: textarea
72+
id: additional-context
73+
attributes:
74+
label: Additional Context
75+
description: Any additional context about this documentation issue
76+
placeholder: Why is this change needed? Who would benefit from it?
77+
78+
- type: checkboxes
79+
id: terms
80+
attributes:
81+
label: Code of Conduct
82+
description: By submitting this issue, you agree to follow our Code of Conduct
83+
options:
84+
- label: I agree to follow this project's Code of Conduct
85+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
projects: []
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**WinCC OA Context**
20+
21+
- How would this feature help with WinCC OA project management?
22+
- Which WinCC OA workflow would this improve?
23+
24+
**Additional context**
25+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)