Skip to content

Commit 5f1ee4c

Browse files
DonghakParkjijoongmoon
DonghakPark
authored and
jijoongmoon
committed
[Docs] Add ISSUE_TEMPLATE
Add ISSUE TEMPLATE to nntrainer - github.sec.samsung.net automatically copies your commit message for your convenience. - Please write your own PR description with this template and remove unused part of the template. **Self evaluation:** 1. Build test: [X]Passed [ ]Failed [ ]Skipped 2. Run test: [X]Passed [ ]Failed [ ]Skipped Signed-off-by: Donghak PARK <donghak.park@samsung.com>
1 parent a7e50bf commit 5f1ee4c

File tree

6 files changed

+175
-0
lines changed

6 files changed

+175
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Issue report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
Having problems with a source code of a github repository?
8+
9+
Having problems with the CI bot that controls the build process?
10+
11+
Good to go? Then please remove these lines above, including this one, and help us understand your issue by answering the following:
12+
13+
# Issue Description
14+
A clear and concise description of what the bug is.
15+
16+
Expected Result
17+
============
18+
A clear and concise description of what you expected to happen.
19+
20+
How to Reproduce
21+
===============
22+
1. Go to '...'
23+
2. Click on '....'
24+
3. Scroll down to '....'
25+
4. See error
26+
27+
28+
Further Information
29+
===============
30+
* A link to an output result showing the issue
31+
* Exact OS version

‎.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
Having problems with a source code of a github repository?
8+
9+
Having problems with the CI bot that controls the build process?
10+
11+
Good to go? Then please remove these lines above, including this one, and help us understand your issue by answering the following:
12+
13+
# Issue Description
14+
A clear and concise description of what the bug is.
15+
16+
Expected Result
17+
============
18+
A clear and concise description of what you expected to happen.
19+
20+
How to Reproduce
21+
===============
22+
1. Go to '...'
23+
2. Click on '....'
24+
3. Scroll down to '....'
25+
4. See error
26+
27+
28+
Further Information
29+
===============
30+
* A link to an output result showing the issue
31+
* Exact OS version

‎.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. For example, I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/Support_request.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Support Request
3+
about: Report a problem with our project source code
4+
5+
---
6+
7+
![WARNING](https://media.giphy.com/media/Zsx8ZwmX3ajny/giphy.gif)
8+
9+
Please only create issues/feature requests for the project here.
10+
11+
For support contact our project maintainer(s), they meet online in a 'Issues' list.
12+
There you can ask questions if you have trouble understanding something, seek advice and mingle with other project members.
13+
For further information see 'Wiki' page.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
---
3+
# [Template] PR Description
4+
5+
In general, github system automatically copies your commit message for your convenience.
6+
Please remove unused part of the template after writing your own PR description with this template.
7+
```bash
8+
$ git commit -s filename1 filename2 ... [enter]
9+
10+
Summarize changes in around 50 characters or less
11+
12+
More detailed explanatory text, if necessary. Wrap it to about 72
13+
characters or so. In some contexts, the first line is treated as the
14+
subject of the commit and the rest of the text as the body. The
15+
blank line separating the summary from the body is critical;
16+
various tools like `log`, `shortlog` and `rebase` can get confused
17+
if you run the two together.
18+
19+
Further paragraphs come after blank lines.
20+
21+
**Changes proposed in this PR:**
22+
- Bullet points are okay, too
23+
- Typically a hyphen or asterisk is used for the bullet, preceded
24+
by a single space, with blank lines in between, but conventions vary here.
25+
26+
Resolves: #123
27+
See also: #456, #789
28+
29+
**Self evaluation:**
30+
1. Build test: [ ]Passed [ ]Failed [*]Skipped
31+
2. Run test: [ ]Passed [ ]Failed [*]Skipped
32+
33+
**How to evaluate:**
34+
1. Describe how to evaluate in order to be reproduced by reviewer(s).
35+
36+
Add signed-off message automatically by running **$git commit -s ...** command.
37+
38+
$ git push origin <your_branch_name>
39+
```
40+

‎.github/SECURITY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security policy
2+
3+
1. [Vulnerability Reports Table](#1-vulnerability-reports-table)
4+
2. [Vulnerability Report](#2-vulnerability-report)
5+
3. [Security Disclosure](#3-security-disclosure)
6+
7+
---
8+
9+
## 1. Vulnerability Reports Table
10+
11+
Table reports on vulnerabilities found and patches/descriptions to mitigating them.
12+
| Version | Vulnerability | Patch/description |
13+
| ----------- | --------------|-------------------|
14+
| 1.x.x | N/A | |
15+
| 2.x.x | N/A | |
16+
17+
---
18+
19+
## 2. Vulnerability Report
20+
21+
Search and fix of vulnerability issue is the highest priority for the NNStreamer project team.
22+
23+
Please report security bugs by contact to [jaeyun-jung](https://github.com/jaeyun-jung) marked "SECURITY".
24+
NNstreamer team will confirm your request and within 2 week will try to prepare recommendations for elimination. Our team will keep you updated on the progress towards the fix until the full announcement of the patch release. During this process, the NNStreamer team may request additional information or guidance.
25+
26+
---
27+
28+
## 3. Security Disclosure
29+
30+
When a person responsible for security receives a vulnerability report as previously mentioned, it is assigned the highest priority and the person in charge. This person will coordinate the patch and release process.
31+
32+
Actions that must be made by the NNStreamer team.
33+
* Confirm the problem and identify the affected versions.
34+
* Check the code to find any similar problems.
35+
* Prepare fixes for all releases still in maintenance. These fixes will
36+
released as quickly as possible.
37+
38+
We suggest the following format when disclosing vulnerabilities:
39+
40+
* Your name and email.
41+
* Include scope of vulnerability. Let us know who could use this exploit.
42+
* Document steps to identify the vulnerability. It is important that we can reproduce your findings.
43+
* How to exploit vulnerability, give us an attack scenario.

0 commit comments

Comments
 (0)