From 3d8754f001a6a39cf3c1d6885098f9125df37408 Mon Sep 17 00:00:00 2001 From: Abhinav Nain Date: Thu, 26 Sep 2024 11:34:44 +0530 Subject: [PATCH] MD Linter changes --- .markdownlint.json | 3 ++- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 4dd4167b..b08910ea 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -6,5 +6,6 @@ "line_length": false, "fenced-code-language": false, "no-emphasis-as-heading": false, - "blanks-around-headings": false + "blanks-around-headings": false, + "first-line-heading": false } diff --git a/README.md b/README.md index 446faabf..3484c13e 100644 --- a/README.md +++ b/README.md @@ -149,20 +149,20 @@ Incorrect: Incorrect: -> Throughout the course of the engagement, a critical severity SQL injection was discovered in the web application (www.example.com) which could be used by an attacker to exfiltrate personally identifiable information from the backend database. +> Throughout the course of the engagement, a critical severity SQL injection was discovered in the web application () which could be used by an attacker to exfiltrate personally identifiable information from the backend database. Correct: -> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information. +> An SQL injection was discovered in allowing a malicious attacker to exfiltrate personally identifiable information. ### Split Up Long Sentences Incorrect: -> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information including email addresses which would be considered a GDPR violation and poses a considerable business risk. +> An SQL injection was discovered in allowing a malicious attacker to exfiltrate personally identifiable information including email addresses which would be considered a GDPR violation and poses a considerable business risk. Correct: -> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information. The retrievable data includes passwords, email addresses and full names. This poses a GDPR violation and considerable business risk. +> An SQL injection was discovered in allowing a malicious attacker to exfiltrate personally identifiable information. The retrievable data includes passwords, email addresses and full names. This poses a GDPR violation and considerable business risk. ## Acronyms @@ -184,7 +184,7 @@ Incorrect: pen test, PenTest, Pen Test ## A vs. An -"An" should be used when the next word starts with a consonant _sound_. Otherwise, "A" should be used. +"An" should be used when the next word starts with a consonant *sound*. Otherwise, "A" should be used. Correct: