OWASP#1204: fixed some more linting issues

taaghche · May 15, 2019 · 2aa1293 · 2aa1293
1 parent 852adb2
commit 2aa1293
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -51,7 +51,6 @@ This document is automatically generated at {{gitbook.time}}
 - Added fix for Fragment Injection on older Android versions
 - Improved sections on iOS webview related testing.
 
-
 1.0.1 17 Sept 2018:
 
 - Updated guiding documentation (README, PR templates, improved styleguide, issue templates).

diff --git a/Document/CHANGELOG.md b/Document/CHANGELOG.md
@@ -51,7 +51,6 @@ This document is automatically generated at {{gitbook.time}}
 - Added fix for Fragment Injection on older Android versions
 - Improved sections on iOS webview related testing.
 
-
 1.0.1 17 Sept 2018:
 
 - Updated guiding documentation (README, PR templates, improved styleguide, issue templates).

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -8,4 +8,4 @@ Thank you for submitting a Pull Request to the Mobile Security Testing Guide. Pl
 - [ ] You verified/tested the effectiveness of your contribution (e.g.: is the code really an effective remediation? Please verify it works!)
 
 If your PR is related to an issue. Please end your PR test with the following line:
-This PR covers issue #<insert number here>.
+This PR covers issue #< insert number here >.
diff --git a/README.md b/README.md
@@ -1,12 +1,11 @@
 <a href="https://leanpub.com/mobile-security-testing-guide"><img width=180px align="right" style="float: right;" src="Document/Images/mstg-cover-release-small.jpg"></a>
 
-
 # OWASP Mobile Security Testing Guide [![Twitter Follow](https://img.shields.io/twitter/follow/OWASP_MSTG.svg?style=social&label=Follow)](https://twitter.com/OWASP_MSTG)
+
 [![Creative Commons License](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-sa/4.0/ "CC BY-SA 4.0")
 [![OWASP Labs](https://img.shields.io/badge/owasp-lab%20project-f7b73c.svg)](https://www.owasp.org/index.php/Category:OWASP_Project#tab=Project_Inventory)
 [![Build Status](https://travis-ci.com/OWASP/owasp-mstg.svg?branch=master)](https://travis-ci.com/OWASP/owasp-mstg)
 
-
 This is the official GitHub Repository of the OWASP Mobile Security Testing Guide (MSTG). The MSTG is a comprehensive manual for mobile app security testing and reverse engineering. It describes technical processes for verifying the controls listed in the [OWASP Mobile Application Verification Standard (MASVS)](https://github.com/OWASP/owasp-masvs "MASVS").
 You can also read the MSTG on [Gitbook](https://mobile-security.gitbook.io/mobile-security-testing-guide/ "MSTG @ Gitbook") or download it as an [e-book](https://leanpub.com/mobile-security-testing-guide-preview "MSTG as an e-book").
 
@@ -71,21 +70,21 @@ The release 1.0 of the MSTG was published in June 2018. You can get intermediate
 
 3. Get the [e-book](https://leanpub.com/mobile-security-testing-guide-preview "MSTG as an e-book"). The book is available for free, but you can choose to purchase it at a price of your choosing if you wish to support our project. All funds raised through sales of the e-book go directly into the project budget and will be used to fund production of future releases.
 
-3. Clone the repository and run the [document generator](https://github.com/OWASP/owasp-mstg/blob/master/Tools/generate_document.sh "The document generator") (requires [pandoc](http://pandoc.org "Pandoc")). This produces docx and HTML files in the "Generated" subdirectory.
+4. Clone the repository and run the [document generator](https://github.com/OWASP/owasp-mstg/blob/master/Tools/generate_document.sh "The document generator") (requires [pandoc](http://pandoc.org "Pandoc")). This produces docx and HTML files in the "Generated" subdirectory.
 
-```shell
-$ git clone https://github.com/OWASP/owasp-mstg/
-$ cd owasp-mstg/Tools/
-$ ./generate_document.sh
-```
+    ```shell
+    $ git clone https://github.com/OWASP/owasp-mstg/
+    $ cd owasp-mstg/Tools/
+    $ ./generate_document.sh
+    ```
 
-4. Clone the repository and run the [gitbook generator](https://github.com/OWASP/owasp-mstg/blob/master/Tools/gitbookepubandpdf.sh "Gitbook based"). This produces PDF, Epub and Mobi files in the "Generated" subdirectory.
+5. Clone the repository and run the [gitbook generator](https://github.com/OWASP/owasp-mstg/blob/master/Tools/gitbookepubandpdf.sh "Gitbook based"). This produces PDF, Epub and Mobi files in the "Generated" subdirectory.
 
-```shell
-$ git clone https://github.com/OWASP/owasp-mstg/
-$ cd owasp-mstg/Tools/
-$ ./gitbookandpdf.sh
-```
+    ```shell
+    $ git clone https://github.com/OWASP/owasp-mstg/
+    $ cd owasp-mstg/Tools/
+    $ ./gitbookandpdf.sh
+    ```
 
 You can also use the [document index](https://rawgit.com/OWASP/owasp-mstg/master/Generated/OWASP-MSTG-Table-of-Contents.html "TOC") to navigate the master branch of the MSTG.
 
@@ -105,10 +104,10 @@ If there's something you really want to see in the guide, or you want to suggest
 If the issue is accepted, we will schedule it into one of our [milestones](https://github.com/OWASP/owasp-mstg/milestones "Milestones").
 
 ### Translating
+
 Our current goal is to publish one minor release every 6 months. Next, we will often create patch updates in order to provide intermediary updates in PDF and DocX format. Releases that have been tagged can then be translated into preferred languages.
 (Note we use semantic versioning: major.minor.patch)
 
-
 ### Contributing
 
 - Fork it ( https://github.com/[my-github-username]/owasp-mstg/ )
@@ -134,4 +133,5 @@ Please ping us or create a pull request if you are missing from the table or in
 If you are willing to write a large portion of the guide and help consistently drive the project forward, you can join as an author. Be aware that you'll be expected to invest lots of time over several months. Contact Sven Schleier (Slack: *sushi2k*) or Jeroen Willemsen (Slack: *jeroenwillemsen*) for more information.
 
 ## Crackmes
+
 In the Crackmes folder, you can find a set of mobile apps to hack. Are you able to find the secrets? For more details: check the [README.md](https://github.com/OWASP/owasp-mstg/blob/master/Crackmes/README.md "Crackmes readme") at the [Crackmes folder](https://github.com/OWASP/owasp-mstg/blob/master/Crackmes "Crackmes folder").
diff --git a/style_guide.md b/style_guide.md
@@ -43,7 +43,7 @@ Include a clear and concise introduction where possible.
 
 Link to background information where necessary.
 
-### Write so people will read with joy!
+### Write so people will read with joy
 
 Use the following methods to increase scannability:
 
@@ -223,20 +223,22 @@ Pictures should be uploaded to the Images/Chapters directory. Afterwards they sh
 
 ## 6. Punctuation conventions
 
-**Lowercase or capital letter after a colon**
+### Lowercase or capital letter after a colon
 
 Chicago Manual of Style (6.61: Lowercase or capital letter after a colon) says: lowercase the first word unless it is a proper noun or the start of at least two complete sentences or a direct question.
 
-**Serial comma use**
+### Serial comma use
 
 Use a serial comma before "and" for the last item in a run-in list of three or more items. For example:
 
 We bought apples, oranges, and tomatoes from the store.
 
-**Quote Marks and Apostrophes**
+### Quote Marks and Apostrophes
+
 Use straight double quotes, straight single quotes, and straight apostrophes (not curly quotes/apostrophes).
 
-**Technical Terms**
+### Technical Terms
+
 Spell/punctuate **specific** technical terms as they are used by the company (e.g., use the company website).
 
 In order of preference, spell/punctuate **generic** technical terms according to
@@ -300,7 +302,7 @@ $ echo 'Hello World'
 Hello World
 ```
 
-**In-text keywords**
+### In-text keywords
 
 When they do not occur in a code block, place the following code-related keywords in backticks (``), double straight quote marks (""), or leave unpunctuated according to the table: