Skip to content

Commit ff01798

Browse files
authored
Merge pull request #10 from octodemo/aegilops-patch-1
Wording, capitalisation, layout
2 parents f42fea5 + bcd04ca commit ff01798

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Code Scanning C# Tutorial
22

3-
Welcome to the Code Scanning C# Tutorial! This tutorial will take you through how to set up Github Advanced Security: Code Scanning as well as interpret results that it may find. The following repository contains cross-site scripting vulnerability for demonstration purpose.
3+
Welcome to the Code Scanning C# Tutorial! This tutorial will take you through how to set up GitHub Advanced Security's Code Scanning, as well as interpret results that it may find. The following repository contains cross-site scripting vulnerabilities for demonstration purposes.
44

55
## Introduction
66

7-
Code scanning is a feature that you use to analyze the code in a GitHub repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in GitHub.
7+
Code Scanning is a feature that you use to analyze the code in a GitHub repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in GitHub.
88

9-
You can use code scanning with CodeQL, a semantic code analysis engine. CodeQL treats code as data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers.
9+
You can use Code Scanning with CodeQL, a semantic code analysis engine. CodeQL treats code as data, allowing you to find potential vulnerabilities in your code with greater confidence than traditional static analyzers.
1010

11-
This tutorial with use CodeQL Analysis with Code Scanning in order to search for vulnerabilities within your code.
11+
This tutorial will use CodeQL analysis with Code Scanning in order to search for vulnerabilities within your code.
1212

1313
## Instructions
1414

@@ -55,18 +55,19 @@ This will create a GitHub Actions Workflow file with CodeQL already set up. Sinc
5555
#### Actions Workflow
5656

5757
The Actions Workflow file contains a number of different sections including:
58+
5859
1. Checking out the repository
5960
2. Initializing the CodeQL Action
6061
3. Running Autobuilder (or code your own build steps if autobuild doesn't work)
6162
4. Running the CodeQL Analysis
6263

6364
<img src="images/03-actions-sample-workflow.png" width="80%"/>
6465

65-
Please change `line 35` to only use `csharp` for this demonstration purpose.
66+
Please change `line 35` to only use `csharp` for this demonstration.
6667

6768
<img src="images/03a-csharp-scanning.png" width="80%"/>
6869

69-
Click `Start Commit` -> `Commit this file` to commit the changes to _main_ branch.
70+
Click `Start Commit` -> `Commit this file` to commit the changes to the _main_ branch.
7071
</p>
7172
</details>
7273

@@ -77,15 +78,15 @@ Click `Start Commit` -> `Commit this file` to commit the changes to _main_ branc
7778

7879
#### Workflow triggers
7980

80-
There are a [number of events](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows) that can trigger a GitHub Actions workflow. In this example, the workflow will be triggered on
81+
There are a [number of events](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows) that can trigger a GitHub Actions workflow. In this example, the workflow will be triggered on:
8182

8283
<img src="images/04-actions-sample-events.png" width="50%"/>
8384

84-
- push to _main_ branch
85-
- pull request to merge to _main_ branch
85+
- push to the _main_ branch
86+
- pull request to merge to the _main_ branch
8687
- on schedule, at 6:33 every Thursday
8788

88-
Setting up the new CodeQL workflow and committing it to _main_ branch in the step above will trigger the scan.
89+
Setting up the new CodeQL workflow and committing it to the _main_ branch in the step above will trigger the scan.
8990

9091
</p>
9192
</details>
@@ -117,13 +118,13 @@ Once the Workflow has completed, click the `Security` tab -> ` Code Scanning Ale
117118

118119
#### Security Alert View
119120

120-
Clicking on the security alert will provide details about the security alert including: <br/>
121-
<ul>
122-
<li>A description of the issue </li>
123-
<li>A tag to the CWE that it is connected to as well as the type of alert (Error, Warning, Note)</li>
124-
<li>The line of code that triggered the security alert</li>
125-
<li>The ability to dismiss the alert depending on certain conditions (`False positive`? `Won't fix`? `Used in tests`?)</li>
126-
</ul>
121+
Clicking on the security alert will provide details about the security alert including:
122+
123+
- A description of the issue
124+
- A tag to the CWE that it is connected to as well as the type of alert (Error, Warning, Note)
125+
- The line of code that triggered the security alert
126+
- The ability to dismiss the alert depending on certain conditions (`False positive`? `Won't fix`? `Used in tests`?)
127+
127128
<img src="images/06-security-codeql-alert.png" width="80%"/>
128129

129130
#### Security Alert Description
@@ -208,7 +209,7 @@ Click on the security alert and notice that it details when the fix was made, by
208209

209210
## Next Steps
210211

211-
Ready to talk about advanced security features for GitHub Enterprise? [Contact Sales](https://enterprise.github.com/contact) for more information!
212+
Ready to talk about Advanced Security features for GitHub Enterprise? [Contact Sales](https://enterprise.github.com/contact) for more information!
212213

213214
Check out [GitHub's Security feature page](https://github.com/features/security) for more security features embedded into GitHub.
214215

0 commit comments

Comments
 (0)