Skip to content

Commit c6c41db

Browse files
committed
Update issue templates
Follow [the instructions at GitHub Documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates) to recreate issue templates. Apply the new format and add new fields.
1 parent 2e089d9 commit c6c41db

9 files changed

Lines changed: 67 additions & 72 deletions

File tree

.github/ISSUE_TEMPLATE/blank_issue.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "Add a placeholder for issue title. ex: [BUG]"
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Is it a security vulnerability?**
10+
If it results in a crash or hang, please refer to [a quick checklist](../../doc/security_need_to_know.md#is-this-bug-considered-a-security-vulnerability) to determine if it is a security vulnerability. If you are still unsure, please report it through [a security advisor](https://github.com/bytecodealliance/wasm-micro-runtime/security/advisories) and allow the maintainer to make a decision. Thank you.
11+
12+
**Describe the bug**
13+
A clear and concise description of what the bug is.
14+
15+
**Version**
16+
Information like tags, release version, commits.
17+
18+
**To Reproduce**
19+
Steps to reproduce the behavior:
20+
21+
1. Compile iwasm with flags like '...'
22+
2. (Optional) Compile wamrc with flags like '....'
23+
3. (Optional) Run wamrc with CLI options like '...' to generate .aot
24+
4. Run iwasm with CLI options like '...'
25+
5. See error
26+
27+
**Expected behavior**
28+
A clear and concise description of what you expected to happen.
29+
30+
**Actual Result**
31+
What you've got.
32+
33+
**Desktop (please complete the following information):**
34+
35+
- Arch [e.g. x86_64, arm64, 32bit]
36+
- Board [e.g. STM32F407]
37+
- OS [e.g. Linux, Windows, macOS, FreeRTOS]
38+
- Version [e.g. 22]
39+
40+
**Additional context**
41+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: 'Add a placeholder for issue title. ex: [RFC]'
5+
labels: help wanted
6+
assignees: ''
7+
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+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/improvement.md

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

.github/ISSUE_TEMPLATE/report_bug.md

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

.github/workflows/compilation_on_zephyr.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111
- synchronize
1212
paths:
1313
- ".github/**"
14+
- "!.github/ISSUE_TEMPLATE/**"
1415
- "build-scripts/**"
1516
- "core/**"
1617
- "!core/deps/**"
@@ -27,6 +28,7 @@ on:
2728
- "dev/**"
2829
paths:
2930
- ".github/**"
31+
- "!.github/ISSUE_TEMPLATE/**"
3032
- "build-scripts/**"
3133
- "core/**"
3234
- "!core/deps/**"

doc/security_need_to_know.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Only bugs that affect [tier A platforms or features](./tired_support.md) should
2929

3030
Actions that differ from Wasm rules (like calculating wrong values) are not seen as security issues as long as they stay within the sandbox.
3131

32-
As embedded code, trusts inputs from the guest. By default, APIs and CLIs are following the principle of **caller guarantee**. If the caller provides incorrect parameters, it is not a security issue. For example, if a user passes an invalid file descriptor to `fd_read`, it is not a security issue.
32+
By default, APIs and CLIs are following the principle of **caller guarantee**. If the caller provides incorrect parameters or users input malformed options, it is not a security issue. For example, if a user passes an invalid file descriptor to `fd_read`, it is not a security issue.
3333

34-
While .aot files are trusted, .wasm files are not. Any unexpected behavior caused by a .wasm file is not a security issue. For example, if a .wasm file causes a runtime crash or hang, it is a security issue. However, if the same .wasm file causes a crash or hang when converted to an .aot file, it is not a security issue.
34+
.wasm are not trusted. Malformed .wasm files should be handled gracefully. If a .wasm file causes a runtime crash or hang, it is a security issue. On the other hand, it's expected that aot runtime alone doesn't provide the same guarantee. So user-crafted aot modules can cause anything, including crashes or hangs. They are not considered security issues.
3535

3636
A denial-of-service (DoS) attack is a cyberattack that aims to make a computer or network resource unavailable to its users. If the service (runtime in this case) can recover and start another module or run another function within the same instance, it is not considered unavailable, and thus not a Denial of Service (DoS).
3737

doc/tiered_suppor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
| RISCV32 | B |
1919
| RISCV64 | B |
2020
| THUMB | B |
21+
| XTENSA | B |
2122
| MIPS | C |
22-
| XTENSA | C |
2323

2424
[^1]: will upgrade to **A** after further testing and validation.
2525

0 commit comments

Comments
 (0)