Skip to content

Commit 90b9875

Browse files
authored
Updated Repository Confirmation & Issue Templates (#559)
* Updated Repository Confirmation & Issue Templates * Updated PR template
1 parent 2bdff65 commit 90b9875

File tree

7 files changed

+128
-26
lines changed

7 files changed

+128
-26
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
* @SgtSilvio
1+
* @pglombardo @SgtSilvio
2+
Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,51 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: 🐛 Bug report
3+
about: If something isn't working 🔧
44
title: ''
5-
labels: ''
6-
assignees: ''
7-
5+
labels: bug
6+
assignees:
87
---
98

10-
## Expected behavior
9+
## 🐛 Bug Report
10+
11+
<!-- If something isn't working for you, we definitely want to know. Thanks for filing an issue! -->
12+
13+
<!-- A clear and concise description of what the bug is. -->
14+
15+
## 🔬 How To Reproduce
16+
17+
Steps to reproduce the behavior:
18+
19+
1. ...
20+
21+
### Code sample
22+
23+
<!-- If applicable, attach a minimal code sample to reproduce the described issue. -->
24+
25+
### Environment
26+
27+
Where are you running/using this client?
28+
29+
Hardware or Device?
30+
31+
What version of this client are you using?
32+
33+
JVM version?
34+
35+
Operating System?
36+
37+
Which MQTT protocol version is being used?
38+
39+
Which MQTT broker (name and version)?
40+
41+
### Screenshots
42+
43+
<!-- If applicable, add screenshots to help explain your problem. -->
1144

12-
## Actual behavior
45+
## 📈 Expected behavior
1346

14-
## To Reproduce
15-
### Steps
47+
<!-- A clear and concise description of what you expected to happen. -->
1648

17-
### Reproducer code
49+
## 📎 Additional context
1850

19-
## Details
20-
- Affected HiveMQ MQTT Client version(s):
21-
- Used JVM version:
22-
- Used OS (name and version):
23-
- Used MQTT version:
24-
- Used MQTT broker (name and version):
51+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
2+
3+
blank_issues_enabled: false
Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
2+
name: 🚀 Feature request
3+
about: Suggest an idea for this project 🏖
44
title: ''
5-
labels: ''
6-
assignees: ''
7-
5+
labels: enhancement
6+
assignees:
87
---
98

10-
## Problem or use case
9+
## 🚀 Feature Request
10+
11+
<!-- A clear and concise description of the feature proposal. -->
12+
13+
## 🔈 Motivation
14+
15+
<!-- Please describe the motivation for this proposal. -->
16+
17+
## 🛰 Alternatives
18+
19+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
20+
21+
## 📎 Additional context
22+
23+
<!-- Add any other context or screenshots about the feature request here. -->
1124

12-
## Preferred solution or suggestions
25+
<!-- ...and thank you for your input - HiveMQ measures success by the success of our user community. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: ❓ Question
3+
about: Ask a question about this project 🎓
4+
title: ''
5+
labels: question
6+
assignees:
7+
---
8+
9+
## Checklist
10+
11+
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`). -->
12+
13+
<!-- Regardless, if something isn't clearly documented or easy to understand - let me know! -->
14+
15+
- [ ] I've searched the project's [`issues`](https://github.com/hivemq/hivemq-mqtt-client/issues?q=is%3Aissue).
16+
- [ ] I've searched the project's [`discussions`](https://github.com/hivemq/hivemq-mqtt-client/discussions).
17+
18+
## ❓ Question
19+
20+
<!-- What is your question -->
21+
22+
How can I [...]?
23+
24+
Is it possible to [...]?
25+
26+
## 📎 Additional context
27+
28+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
**Motivation**
1+
## Description
22

3+
<!-- Add a more detailed description of the changes if needed. -->
34

4-
**Changes**
5+
## Related Issue
6+
7+
<!-- If your PR refers to a related issue, link it here. -->
8+
9+
## Type of Change
10+
11+
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
12+
13+
- [ ] 📚 Examples / docs / tutorials / dependencies update
14+
- [ ] 🔧 Bug fix (non-breaking change which fixes an issue)
15+
- [ ] 🥂 Improvement (non-breaking change which improves an existing feature)
16+
- [ ] 🚀 New feature (non-breaking change which adds functionality)
17+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
18+
- [ ] 🔐 Security fix
19+
20+
## Checklist
21+
22+
<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
23+
24+
- [ ] I've written tests (if applicable) for all new methods and classes that I created.
25+
- [ ] I've added documentation as necessary so users can easily use and understand this feature/fix.

.github/SECURITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
This project supports only the latest version with security updates. However, we'll do our best to help and answer questions about older versions.
6+
7+
## Reporting a Vulnerability
8+
9+
Contact [[email protected]|@pglombardo] to report a security vulnerability. You will be thanked!

0 commit comments

Comments
 (0)