Skip to content

Commit c033e5e

Browse files
nashifnashif
committed
templates
Signed-off-by: Anas Nashif <[email protected]>
1 parent 62fb6eb commit c033e5e

File tree

6 files changed

+221
-165
lines changed

6 files changed

+221
-165
lines changed

‎.github/ISSUE_TEMPLATE/002_enhancement.md‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/002_enhancement.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Enhancement
2+
description: Submit an Enhancement
3+
labels: ["Enhancement"]
4+
type: "Enhancement"
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this enhancement proposal.
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Summary
15+
description: |
16+
Is your enhancement proposal related to a problem? Please describe.
17+
placeholder: |
18+
A clear and concise description of what the problem is.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Describe the solution you'd like
25+
description: |
26+
Describe the solution you'd like
27+
placeholder: |
28+
A clear and concise description of what you want to happen.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives
35+
description: Describe alternatives you've considered
36+
placeholder: |
37+
A clear and concise description of any alternative solutions or features you've considered.
38+
- type: textarea
39+
id: context
40+
attributes:
41+
label: Additional Context
42+
description: Add any other context or graphics (drag-and-drop an image) about the feature request here.

‎.github/ISSUE_TEMPLATE/003_rfc-proposal.md‎

Lines changed: 0 additions & 60 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/003_rfc-proposal.yaml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: RFC / Proposal
2+
description: Submit a Proposal (RFC)
3+
title: ""
4+
labels: [RFC]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Introduction
11+
12+
This section targets end users, TSC members, maintainers and anyone else
13+
that might need a quick explanation of your proposed change.
14+
15+
- type: textarea
16+
id: problem-description
17+
attributes:
18+
label: Problem Description
19+
description: Why do we want this change and what problem are we trying to address?
20+
placeholder: Explain the problem or limitation this RFC is meant to resolve.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: proposed-change-summary
26+
attributes:
27+
label: Proposed Change (Summary)
28+
description: A high-level summary of the proposed change (the 10,000 ft view).
29+
placeholder: Brief summary of what will change if this RFC is implemented.
30+
validations:
31+
required: true
32+
33+
- type: markdown
34+
attributes:
35+
value: |
36+
## Detailed RFC
37+
38+
This section targets the development team. Upon reading it, each engineer
39+
should understand what must be done to implement the proposed feature.
40+
41+
- type: textarea
42+
id: detailed-change
43+
attributes:
44+
label: Proposed Change (Detailed)
45+
description: Describe the change in as much detail as possible. Include context or background info, and reuse of existing components if applicable.
46+
placeholder: Explain exactly what you’re planning to change and how.
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: dependencies
52+
attributes:
53+
label: Dependencies
54+
description: Highlight how this change may affect the rest of the project or other teams/components.
55+
placeholder: List components, modules, or teams affected.
56+
validations:
57+
required: false
58+
59+
- type: textarea
60+
id: concerns
61+
attributes:
62+
label: Concerns and Unresolved Questions
63+
description: List any concerns, unknowns, or unresolved questions related to this proposal.
64+
placeholder: Any areas of uncertainty?
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: alternatives
70+
attributes:
71+
label: Alternatives Considered
72+
description: What alternative solutions were considered? Why was this proposal chosen?
73+
placeholder: List alternatives and explain the rationale behind your choice.
74+
validations:
75+
required: false
76+

‎.github/ISSUE_TEMPLATE/007_ext-source.md‎

Lines changed: 0 additions & 77 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/007_ext-source.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: External Component Integration
2+
description: Propose integration of an external open source component
3+
labels: ["TSC"]
4+
assignees: []
5+
body:
6+
- type: textarea
7+
id: origin
8+
attributes:
9+
label: Origin
10+
description: Name of project hosting the original open source code. Provide a link to the source.
11+
placeholder: e.g., SQLite - https://sqlite.org
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: purpose
17+
attributes:
18+
label: Purpose
19+
description: Brief description of what this software does.
20+
placeholder: e.g., A small, fast, self-contained SQL database engine.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: integration-mode
26+
attributes:
27+
label: Mode of Integration
28+
description: Should this be integrated in the main tree or as a module? Explain your choice and suggest a module repo name if applicable.
29+
placeholder: e.g., As a module - proposed repo name: zephyr-sqlite
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: maintainership
35+
attributes:
36+
label: Maintainership
37+
description: List maintainers (GitHub IDs) for this integration. Include at least one primary maintainer.
38+
placeholder: e.g., @username1 (primary), @username2 (collaborator)
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: pull-request
44+
attributes:
45+
label: Pull Request
46+
description: Link to the pull request (if any) for this integration. Must be labeled "DNM" (Do Not Merge).
47+
placeholder: e.g., https://github.com/zephyrproject-rtos/zephyr/pull/12345
48+
validations:
49+
required: false
50+
51+
- type: textarea
52+
id: description
53+
attributes:
54+
label: Description
55+
description: Long-form description to justify suitability of this component.
56+
placeholder: |
57+
- What is its primary functionality?
58+
- What problem does it solve?
59+
- Why is this the right component?
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: security
65+
attributes:
66+
label: Security
67+
description: Security-related aspects of this component, including cryptographic functions and known vulnerabilities.
68+
placeholder: |
69+
- Does it use cryptography?
70+
- How are vulnerabilities handled?
71+
- Any known CVEs?
72+
validations:
73+
required: false
74+
75+
- type: textarea
76+
id: dependencies
77+
attributes:
78+
label: Dependencies
79+
description: What does this component depend on, and how will it be integrated (directly or via abstraction)?
80+
placeholder: |
81+
- Other external packages?
82+
- Direct or abstracted use in Zephyr?
83+
validations:
84+
required: false
85+
86+
- type: input
87+
id: revision
88+
attributes:
89+
label: Version or SHA
90+
description: Which version or specific commit should be initially integrated?
91+
placeholder: e.g., v3.45.0 or 79cc94d
92+
validations:
93+
required: true
94+
95+
- type: input
96+
id: license
97+
attributes:
98+
label: License (SPDX)
99+
description: Provide the license using a valid SPDX identifier (e.g., BSD-3-Clause).
100+
placeholder: e.g., MIT or BSD-3-Clause
101+
validations:
102+
required: true
103+

0 commit comments

Comments
 (0)