Skip to content

Commit 951fe8e

Browse files
jamali005jamali005
authored
GitHub Issues template (#4)
* Create SECURITY.md * Add GitHub issue templates * Update README
1 parent 5831563 commit 951fe8e

File tree

6 files changed

+124
-1
lines changed

6 files changed

+124
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: "⛔ Bug Report"
3+
description: Report a bug
4+
title: "short issue description"
5+
labels: [bug]
6+
assignees: []
7+
body:
8+
- type: input
9+
id: Board
10+
attributes:
11+
label: Board type
12+
description: e.g. nrf9160 dk | thingy91 | STM32 P-L496G-CELL02
13+
validations:
14+
required: true
15+
- type: input
16+
id: Modem
17+
attributes:
18+
label: Modem
19+
description: e.g. BG96 | SARA-R4
20+
validations:
21+
required: false
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Describe the bug
26+
description: What is the problem? A clear and concise description of the bug.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: expected
31+
attributes:
32+
label: Expected Behavior
33+
description: |
34+
What did you expect to happen?
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: current
39+
attributes:
40+
label: Current Behavior
41+
description: |
42+
What actually happened?
43+
Please include full errors, and relevant logs.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: reproduction
48+
attributes:
49+
label: Reproduction Steps
50+
description: |
51+
Provide a short, self-contained, Correct, concise snippet of code that can be used to reproduce the issue.
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: other
56+
attributes:
57+
label: Other information
58+
description: |
59+
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
60+
validations:
61+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 General Question
5+
url: https://github.com/1NCE-GmbH/blueprint-freertos/discussions/categories/q-a
6+
about: Please ask and answer questions as a discussion thread

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "✍ Documentation Issue"
3+
description: Report an issue in the documentation
4+
title: "short issue description"
5+
labels: [documentation]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: links
18+
attributes:
19+
label: Links
20+
description: |
21+
Include links to affected documentation page(s).
22+
validations:
23+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 🤝 Feature Request
3+
description: Suggest an idea for this project
4+
title: "short feature description"
5+
labels: [feature-request]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: other
25+
attributes:
26+
label: Other Information
27+
description: |
28+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
29+
validations:
30+
required: false

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,6 @@ for more information on the troubleshooting
205205

206206
## Asking for Help
207207

208-
You can ask for help on our email [[email protected]](mailto:embedded@1nce.com). Please send bug reports and feature requests to GitHub.
208+
The most effective communication with our team is through GitHub. Simply create a [new issue](https://github.com/1NCE-GmbH/blueprint-freertos/issues/new/choose) and select from a range of templates covering bug reports, feature requests, documentation issue, or Gerneral Question.
209209

210210

‎SECURITY.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Reporting a Vulnerability
2+
3+
The security of our project is of utmost importance. If you discover any potential security issues, we kindly request that you notify 1NCE GmbH Security directly by sending an email to [email protected]. This helps to ensure that the issue is addressed promptly and confidentially. Please refrain from creating a public issue on GitHub as this may compromise the integrity and confidentiality of the information involved. We appreciate your cooperation and support in maintaining the security of our project.

0 commit comments

Comments
 (0)