Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit be04085

Browse files
committed
Added a PR template and updated the ISSUE templates.
1 parent e9857f9 commit be04085

File tree

7 files changed

+29
-9
lines changed

7 files changed

+29
-9
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: bug
55

66
---
77
<!--
8-
Thanks for reporting an issue in the documentation 🙌 ❤️
8+
Thank you for reporting an issue in our project 🙌
99
1010
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
1111
-->

.github/ISSUE_TEMPLATE/documentation_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: documentation
55

66
---
77
<!--
8-
Thanks for reporting an issue in our documentation 🙌 ❤️
8+
Thank you for reporting an issue in our documentation 🙌
99
1010
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
1111
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
name: "Feature request"
2+
name: "Feature request"
33
about: "Suggest an idea for this project"
44

55
---
66
<!--
7-
Thanks for reporting an issue in our documentation 🙌 ❤️
7+
Thank you for reporting an issue in our documentation 🙌
88
99
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
1010
-->

.github/ISSUE_TEMPLATE/new_hook.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: 'hook'
55
---
66

77
<!--
8-
Thanks for contributing to the project 🙌 ❤️
8+
Thank you for contributing to our project 🙌
99
1010
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, please, have a look at our FAQs and existing questions before opening a new question.
1111
-->
@@ -29,7 +29,7 @@ Before opening a new issue, please make sure that we do not have any duplicates
2929
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/docs/developer-guide)
3030
-->
3131

32-
- [ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/scanners), based on the existing template
32+
- [ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/scanners), based on the existing template
3333
- [ ] Add a README.md and give a brief overview of the scanner and its configuration options.
3434
- [ ] Implement a new scanner specific scan-type.yaml
3535
- [ ] Implement a new scanner specific parse-definition.yaml
@@ -38,4 +38,4 @@ Hint: A general guide how to implement a new scanner is documented [here](https:
3838
- [ ] Use the parserSDK to implement a new findings parser (currently based on NodeJS)
3939
- [ ] Add unit tests with at minimum 80% test coverage
4040
- [ ] Add some example scan.yaml and finding.yaml files in the example folder
41-
- [ ] Implement a new integration test for the scanner [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/tests/integration)
41+
- [ ] Implement a new integration test for the hook [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/tests/integration)

.github/ISSUE_TEMPLATE/new_security_scanner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: 'scanner'
55
---
66

77
<!--
8-
Thanks for contributing to the project 🙌 ❤️
8+
Thank you for contributing to our project 🙌
99
1010
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, please, have a look at our FAQs and existing questions before opening a new question.
1111
-->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: question
55

66
---
77
<!--
8-
Thanks for contributing to the project 🙌 ❤️
8+
Thank you for supporting our project 🙌
99
1010
Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, please, have a look at our FAQs and existing questions before opening a new question.
1111
-->

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--
2+
Thank you for your contribution to our Project 🙌
3+
4+
Before submitting your Pull Request, please take the time to check the points below and provide some descriptive information.
5+
* [ ] If this PR comes from a fork, please [Allow edits from maintainers](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
6+
* [ ] Set a meaningful title. Format: {task_name} (closes #{issue_number}). For example: Use logger (closes #41)
7+
* [ ] [Link your Pull Request to an issue](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) (if applicable)
8+
* [ ] Create Draft pull requests if you need clarification or an explicit review before you can continue your work item.
9+
* [ ] Make sure that your PR is not introducing _unncessary_ reformatting (e.g., introduced by on-save hooks in your IDE)
10+
* [ ] Make sure each new source file you add has a correct license header.
11+
-->
12+
13+
## Checklist
14+
15+
* [ ] Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
16+
* [ ] Make sure `npm test` runs for the whole project.
17+
18+
## Description
19+
20+
<!-- Please be brief in describing which issue is solved by your PR or which enhancement it brings -->

0 commit comments

Comments
 (0)