Merge pull request spearbit-audits#7 from spearbit-audits/format-fixes

Update formatting in report.md; add repo name and commit hash to CI artifact names

.github/workflows/build.yml

@@ -32,6 +32,6 @@ jobs:
       - name: Uploads the generated pdf
         uses: actions/upload-artifact@v2
         with:
-          name: spearbit.pdf
+          name: spearbit-${{ github.event.repository.name }}-${{ github.sha }}.pdf
           path: main.pdf
       - run: echo "🍏 This job's status is ${{ job.status }}."

report.md

@@ -13,31 +13,43 @@ The focus of the security review was on the following:
 2. Specific security concern 2.
 3. Specific security concern 3.
 
-*Disclaimer*: This security review does not guarantee against a hack. It is a snapshot in time of brink according to the specific commit by a three person team. Any modifications to the code will require a new security review.
+*Disclaimer:* This security review does not guarantee against a hack. It is a snapshot in time of brink according to the specific commit by a three person team. Any modifications to the code will require a new security review.
 
 # Findings 
 
-## High Severity
-### Actual Issue
+## Critical Risk
 
-**Severity**: Low, Gas optimization
+## High Risk
+### Issue title (Only first word should be capitalized; titles should never end with punctuation)
 
-Context: [`Contract.sol#L160-L165`](https://github.com/actuallink)
+**Severity:** High
+
+**Context:** [`Contract.sol#L160-L165`](https://github.com/actuallink)
+
+**Description:**
 
 ```solidity
 contract Test {
+    ...
+    // Code blocks must be indented with 4 spaces.
 }
 ```
 
-**Recommendation**:
+**Recommendation:**
+```diff
++ use diff syntax to describe what should be changed
+- ...
+```
+
+**Project:** Fixed in [PR #1](Https://github.com/actuallink).
 
-**Project**: Fixed in [PR #1](Https://github.com/actuallink).
+**Spearbit:** Resolved.
 
-**Spearbit**: Resolved.
+## Medium Risk
 
-## Medium Severity
+## Low Risk
 
-## Low Severity
+## Gas Optimizations
 
 
 # Additional Comments