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

Commit 5963b70

Browse files
J12934J12934
authored
Merge pull request #124 from secureCodeBox/feature/improve-readme-files
Updating ISSUE_TEMPLATES and PR TEMPLATE
2 parents 58ea60e + 02314cf commit 5963b70

File tree

13 files changed

+187
-42
lines changed

13 files changed

+187
-42
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,42 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: "🐞 Bug report"
3+
about: Please create a bug report if you encouter any project specific issue.
4+
labels: bug
45

56
---
7+
<!--
8+
Thank you for reporting an issue in our project 🙌
9+
10+
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.
11+
-->
612

713
**Describe the bug**
8-
A clear and concise description of what the bug is.
14+
<!-- A clear and concise description of what the bug is. -->
915

1016
**To Reproduce**
17+
<!--
1118
Steps to reproduce the behavior:
1219
1. Go to '...'
1320
2. Click on '....'
1421
3. Scroll down to '....'
1522
4. See error
23+
-->
1624

1725
**Expected behavior**
18-
A clear and concise description of what you expected to happen.
26+
<!-- A clear and concise description of what you expected to happen. -->
1927

2028

2129
**System (please complete the following information):**
30+
<!--
31+
- secureCodeBox Version/Release
2232
- OS: [e.g. iOS]
33+
- Kubernetes Version [command: `kubectl version`]
2334
- Docker Version [command: `docker -v`]
24-
- Docker Compose Version [command: `docker-compose -v`]
25-
- Browser [e.g. chrome, safari]
35+
- Browser [e.g. chrome, safari, firefox,...]
36+
-->
2637

2738
**Screenshots / Logs**
28-
If applicable, add screenshots to help explain your problem.
39+
<!-- If applicable, add screenshots to help explain your problem. -->
2940

3041
**Additional context**
31-
Add any other context about the problem here.
42+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "📚 Documentation Issue"
3+
about: "Did you come across parts of our documentation that should be fixed?"
4+
labels: documentation
5+
6+
---
7+
<!--
8+
Thank you for reporting an issue in our documentation 🙌
9+
10+
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.
11+
-->
12+
13+
## Where to find the issue
14+
<!-- Be as specific as possible by naming the document, page, and ideally paragraph. -->
15+
16+
## Describe the issue
17+
<!-- Please let us know what exactly is the issue with that part of the documentation -->
18+
19+
## Suggested change
20+
<!-- If you have ideas on how to fix this issue, please note them here, or consider creating a Pull Request -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

55
---
6+
<!--
7+
Thank you for reporting an issue in our documentation 🙌
8+
9+
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.
10+
-->
611

712
**Is your feature request related to a problem? Please describe.**
8-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
914

1015
**Describe the solution you'd like**
11-
A clear and concise description of what you want to happen.
16+
<!-- A clear and concise description of what you want to happen. -->
1217

1318
**Describe alternatives you've considered**
14-
A clear and concise description of any alternative solutions or features you've considered.
19+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1520

1621
**Additional context**
17-
Add any other context or screenshots about the feature request here.
22+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/new_hook.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: '⚓️ New Hook request'
3+
about: 'Suggest an idea for a new data processing or integration hook in this project.'
4+
labels: 'hook'
5+
---
6+
7+
<!--
8+
Thank you for contributing to our project 🙌
9+
10+
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.
11+
-->
12+
13+
## New Hook implementation request
14+
15+
**Is your feature request related to a problem? Please describe.**
16+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
17+
18+
**Describe the solution you'd like**
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
**Describe alternatives you've considered**
22+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
23+
24+
**Additional context**
25+
<!-- Add any other context or screenshots about the feature request here. -->
26+
27+
## Steps to implement a new Hook
28+
<!--
29+
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/docs/developer-guide)
30+
-->
31+
32+
- [ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/hooks)
33+
- [ ] Add a README and give a brief overview of the scanner and its configuration options.
34+
- [ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
35+
- [ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
36+
- [ ] Add unit tests with at minimum 80% test coverage
37+
- [ ] Add some example scan.yaml and finding.yaml files in the example folder
38+
- [ ] 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: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,39 @@
11
---
2-
name: 'New Security Scanner request'
2+
name: '🚓 New Security Scanner request'
33
about: 'Suggest an idea for a new security scanner to integrate in this project.'
4-
labels: 'security scanner'
4+
labels: 'scanner'
55
---
6+
7+
<!--
8+
Thank you for contributing to our project 🙌
9+
10+
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.
11+
-->
12+
613
## New Scanner implementation request
714

815
**Is your feature request related to a problem? Please describe.**
9-
- _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
16+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1017

1118
**Describe the solution you'd like**
12-
- _A clear and concise description of what you want to happen._
19+
<!-- A clear and concise description of what you want to happen. -->
1320

1421
**Describe alternatives you've considered**
15-
- _A clear and concise description of any alternative solutions or features you've considered._
22+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1623

1724
**Additional context**
18-
- _Add any other context or screenshots about the feature request here._
25+
<!-- Add any other context or screenshots about the feature request here. -->
1926

2027
## Steps to implement a new scanner
21-
> Hint: A general guide how to implement a new scanner is documented [here]( https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#developing-own-processes)
22-
23-
### Must have
24-
- [ ] Create a [new public secureCodeBox repository](https://github.com/organizations/secureCodeBox/repositories/new) for the scanner implementation
25-
- [ ] Implement a new scanner microservice an reuse some of the existing stuff, if possible
26-
- [ ] Check if there is a [healthcheck](https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#healthchecks-for-scanner-microservices) for the microservice implemented
27-
- [ ] Implement a [new basic security process](https://github.com/secureCodeBox/secureCodeBox/blob/master/docs/developer-guide/README.md#developing-a-process-model) for the scanner
28-
- [ ] Update the [docker-compose](https://github.com/secureCodeBox/secureCodeBox/blob/master/docker-compose.yml) files and integrate your new scanner there
29-
- [ ] Update the [user guide](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/user-guide) and [developer guide](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
30-
- [ ] Implement a integration test for the scanner [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/test)
31-
32-
### Should have
33-
- [ ] Update the [CLI examples](https://github.com/secureCodeBox/secureCodeBox/tree/master/cli)
34-
- [ ] Update the [Jenkins Pipeline](https://github.com/secureCodeBox/integration-pipeline-jenkins-examples) examples
35-
- [ ] Update the [OpenShift Container Setup](https://github.com/secureCodeBox/ansible-role-securecodebox-openshift)
28+
<!--
29+
Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/docs/developer-guide)
30+
-->
31+
32+
- [ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/scanners)
33+
- [ ] Add a README.md and give a brief overview of the scanner and its configuration options.
34+
- [ ] Implement a new scanner specific scan-type.yaml
35+
- [ ] Implement a new scanner specific parse-definition.yaml
36+
- [ ] Add (optional) some cascading-rules.yaml
37+
- [ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
38+
- [ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox-v2/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
39+
- [ ] Add unit tests with at minimum 80% test coverage

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: "🤨 Question"
3+
about: "If you have *specific* questions about the project, please post them here."
4+
labels: question
5+
6+
---
7+
<!--
8+
Thank you for supporting our project 🙌
9+
10+
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.
11+
-->
12+
13+
## Your Question
14+
<!-- Include details about your question. -->

‎.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 -->

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ The typical way to ensure application security is to hire a security specialist
6565

6666
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
6767

68-
The purpose of _secureCodeBox_ **is not** to replace the penetration testers or make them obsolete. We strongly recommend running extensive tests by experienced penetration testers on all your applications.
68+
![secureCodeBox Architecture](./docs/resources/macbook_kibana.jpg)
69+
70+
The purpose of _secureCodeBox_ **is not** to replace the penetration testers or make them obsolete. We strongly recommend to run extensive tests by experienced penetration testers on all your applications.
6971

7072
**Important note**: The _secureCodeBox_ is no simple one-button-click-solution! You must have a deep understanding of security and how to configure the scanners. Furthermore, an understanding of the scan results and how to interpret them is also necessary.
7173

‎docs/_config.yml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/glossary.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Glossary
2+
3+
This overview provides a description for all acronyms and special terms which are used in this project. If you encounter any missing terms, please [let us know](https://github.com/corona-warn-app/cwa-documentation/issues/new?labels=documentation%2C+bug&template=01_doc_issue.md) or [create a pull request](https://github.com/secureCodeBox/secureCodeBox-v2/pulls).
4+
5+
| Term, acronym... | Description |
6+
| --- | --- |
7+
| API | An [Application Programming Interface](https://en.wikipedia.org/wiki/Application_programming_interface) (API) is a computing interface which defines interactions between multiple software intermediaries. |
8+
| CRD | Acronym for "[Custom Ressource Definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)". |
9+
| GUID | Acronym for "[Globally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier)". |
10+
| K8S | Acronym for "[Kubernetes](https://kubernetes.io/docs/home/)". |
11+
| SCB | Acronym for "[secureCodeBox (This Project)](https://www.secureCodeBox.io)". |
12+
13+

0 commit comments

Comments
 (0)