Project linting

[irish1986]

Pull Request

Context

Markdown is a loosly and flexible syntax language meaning there are severals ways to express the same content (i.e.: unnumbered list). I am proposing a large refactoring of this project to improve consistency and standardize its Markdown structure. In the spirit of DevSecOps, I am suggesting that we leverage pre-commit hooks for Markdown linting.

Description

Leveraging the pre-commit framwork, I have added a series of standardize hooks implementing these rules:

• general | check JSON files
• general | check TOML files
• general | check XML files
• general | check YAML files
• general | fix end of file
• general | fix line ending
• general | prettify JSON files
• general | remove trailing whitespace
• gh-action | lint: pinned sha
• git | block large files
• git | forbid new submodules
• git | forbid submodules usage
• md | lint: run markdownlint-cli

The md | lint: run markdownlint-cli hook is using .config/.markdown-lint.yml as a reference on how to lint and treat various Markdown syntaxe. Conention could be organized via this file. These changes a very cosmectic (and nit picky) although given the nature of this project (a series of .md files explaining DevSecOps) it seems to be logical to improve on this.

Furthermore, given some people might forget to initialize & run pre-commit locally¹ before opening a PR, a new GitHub Action as been created runing it.

Changes

No significant changes have been made, this was mostly a simple project refactor|rewrite to apply standardize linting rules.

Legacy section old-versions has been excluded from this effort for consistency and historical accuracy.

Supplement

I am planning on a series of contribution to this project based on my profesionnal experience. I wish to share my taught and improve this project but it made sense to start tidying up it before adding more content.

Footnotes

1. I have planned to add a CONTRIBUTION.md including details about running pre-commit but in the spirit of only refactoring code I have omitted this for now. ↩

[irish1986]

Comments and criticisms are welcomed.

[irish1986]

@Ali-Yazdani or @milanowasp

Any chance we could discuss this PR? What process should be followed to contribute actively to this project?

[milanowasp]

@Ali-Yazdani or @milanowasp

Any chance we could discuss this PR? What process should be followed to contribute actively to this project?

Let us connect this week.
The PR can be reviewed and merged according to what the content is getting upgraded or amended to existing content. Let us connect for this and discuss it out. We also have slack channel which can be leveraged.

[Ali-Yazdani]

@irish1986, Thanks for your contribution. That is so great. Let us review it. I also set up a notification channel to receive any contribution activity from now on.

[irish1986]

Thanks for merging this, I got plenty of new stuff coming up. I'll try to get in touch via slack.