Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation changes to .md files #816

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Documentation changes to .md files #816

wants to merge 5 commits into from
+148 −23

Commits on Jan 31, 2024

  1. Update README.md to be more consistent with markdown linters 

    Changes were made to be consistent with rules set by popular markdown linting tools.

Specifically, rules in vs code plugin "markdownlint" by David Anson was used for the changes to fix violations of the following rules:

MD022
MD004
MD007
MD012
MD040
MD032
MD031

Rules found on the github repo here:

https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
    @AsherAli-SWE
    AsherAli-SWE authored Jan 31, 2024
    Configuration menu
    Copy the full SHA
    4308a5a View commit details
    Browse the repository at this point in the history

  2. Update SECURITY.md 

    Changes were made to be consistent with rules set by popular markdown linting tools.

Specifically, rules in vs code plugin "markdownlint" by David Anson was used for the changes to fix violations of the following rules:

MD041
MD009
MD007


Rules found on the github repo here:

https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
    @AsherAli-SWE
    AsherAli-SWE authored Jan 31, 2024
    Configuration menu
    Copy the full SHA
    b98d00b View commit details
    Browse the repository at this point in the history

  3. Update README.md 

    Changes were made to be consistent with rules set by popular markdown linting tools.

Specifically, rules in vs code plugin "markdownlint" by David Anson was used for the changes to fix violations of the following rules:

MD022
MD012
MD004
MD007
MD040
MD032
MD031

Although rule MD004 is a stylistic choice to alternate between symbols, it is inconsistent with the latest markdown document in the repository "CHANGELOG.MD" which uses hyphens for lists.

Rules listed above can be found here:

https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
    @AsherAli-SWE
    AsherAli-SWE authored Jan 31, 2024
    Configuration menu
    Copy the full SHA
    83c8f2c View commit details
    Browse the repository at this point in the history

  4. Update CHANGELOG.md to remove inconsitencies 

    Changes were made to closer match the format of the markdown used by "Keep a Changelog".

Changes were made to remove inconsistencies between different sections of the changelog (i.e. Updated: and Updated)

Changes were made to be consistent with rules set by popular markdown linting tools.

Specifically, rules in vs code plugin "markdownlint" by David Anson was used for the changes to fix violations of the following rules:

MD022
MD032
MD026
    @AsherAli-SWE
    AsherAli-SWE authored Jan 31, 2024
    Configuration menu
    Copy the full SHA
    1f10009 View commit details
    Browse the repository at this point in the history

  5. Update SECURITY.md to remove inconsistencies 

    Changed * list to - to be consistent with CHANGELOG.md and README.MD
    @AsherAli-SWE
    AsherAli-SWE authored Jan 31, 2024
    Configuration menu
    Copy the full SHA
    34e6251 View commit details
    Browse the repository at this point in the history