Skip to content

Commit 8efb902

Browse files
added templates
1 parent 2a50a13 commit 8efb902

4 files changed

Lines changed: 181 additions & 0 deletions

File tree

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: ['bug']
6+
assignees: []
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## Expected Behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
A clear and concise description of what actually happened.
27+
28+
## Screenshots
29+
30+
If applicable, add screenshots to help explain your problem.
31+
32+
## Environment
33+
34+
- **OS**: [e.g., Windows 10, Ubuntu 22.04]
35+
- **Python Version**: [e.g., 3.10.5]
36+
- **Browser**: [e.g., Chrome 120, Firefox 121]
37+
- **Django Version**: [e.g., 5.0]
38+
- **Deployment**: [e.g., Docker, local development, production]
39+
40+
## Modbus Configuration (if applicable)
41+
42+
- **Protocol**: [RTU/TCP]
43+
- **Interface**: [e.g., COM3, TCP 192.168.1.100:502]
44+
- **Device**: [e.g., PLC model, sensor type]
45+
46+
## Error Messages/Logs
47+
48+
```
49+
Paste any relevant error messages or log output here
50+
```
51+
52+
## Additional Context
53+
54+
Add any other context about the problem here. This could include:
55+
- When did the issue start occurring?
56+
- Does it happen consistently or intermittently?
57+
- Have you made any recent changes to the configuration?
58+
- Any workarounds you've tried?
59+
60+
## Possible Solution
61+
62+
If you have suggestions on how to fix the bug, please describe them here.

.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: Documentation
4+
url: https://github.com/YOUR_USERNAME/modbus-webserver/tree/main/docs
5+
about: Check the documentation for guides and examples
6+
- name: Discussions
7+
url: https://github.com/YOUR_USERNAME/modbus-webserver/discussions
8+
about: Ask questions and discuss ideas with the community
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: ['enhancement']
6+
assignees: []
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Problem Statement
14+
15+
Describe the problem this feature would solve. Example: "I'm always frustrated when..."
16+
17+
## Proposed Solution
18+
19+
A clear and concise description of what you want to happen. Include:
20+
- How should it work?
21+
- What should users be able to do?
22+
- Any specific implementation ideas?
23+
24+
## Alternative Solutions
25+
26+
Describe any alternative solutions or features you've considered.
27+
28+
## Use Case
29+
30+
Describe the use case for this feature:
31+
- Who would benefit from this?
32+
- In what scenarios would this be useful?
33+
- How often would you use this feature?
34+
35+
## Examples
36+
37+
If applicable, provide examples of:
38+
- Similar features in other applications
39+
- Mock-ups or wireframes
40+
- Sample code or configuration
41+
42+
## Benefits
43+
44+
What benefits would this feature provide?
45+
- Improved user experience
46+
- Better performance
47+
- Enhanced functionality
48+
- Easier configuration
49+
50+
## Implementation Complexity
51+
52+
Do you have thoughts on the implementation complexity?
53+
- Simple (minor UI change, small feature)
54+
- Medium (new component, moderate changes)
55+
- Complex (major feature, significant changes)
56+
57+
## Additional Context
58+
59+
Add any other context, screenshots, or examples about the feature request here.
60+
61+
## Willingness to Contribute
62+
63+
- [ ] I would be willing to implement this feature
64+
- [ ] I would be willing to test this feature
65+
- [ ] I would be willing to write documentation for this feature

.github/ISSUE_TEMPLATE/question.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Question
3+
about: Ask a question about usage or configuration
4+
title: '[QUESTION] '
5+
labels: ['question']
6+
assignees: []
7+
---
8+
9+
## Question
10+
11+
Clearly state your question here.
12+
13+
## Context
14+
15+
Provide context for your question:
16+
- What are you trying to accomplish?
17+
- What have you already tried?
18+
- Where are you in the process?
19+
20+
## Environment
21+
22+
- **OS**: [e.g., Windows 10, Ubuntu 22.04]
23+
- **Python Version**: [e.g., 3.10.5]
24+
- **Deployment**: [e.g., Docker, local development]
25+
26+
## Configuration (if applicable)
27+
28+
```python
29+
# Paste relevant configuration or code here
30+
```
31+
32+
## Documentation Checked
33+
34+
Have you checked the existing documentation?
35+
- [ ] README.md
36+
- [ ] QUICKSTART.md
37+
- [ ] docs/ folder
38+
- [ ] Existing issues
39+
40+
## Related Issues
41+
42+
Are there any related issues or discussions? Link them here.
43+
44+
## Additional Information
45+
46+
Add any other relevant information or context.

0 commit comments

Comments
 (0)