Documentation changes to .md files #816
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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
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
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
Changed * list to - to be consistent with CHANGELOG.md and README.MD
|
Hi @AsherAtTrent, Thank you for contribution. I'm ok for making changes to readme and changelog. Please not change the |
|
gh pr checkout 816 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes I made and why
Added changes to markdown files to be more consistent with each other in terms of formatting. I followed the linting rules of markdownlint, a popular VS code plugin, and the formatting of Keep a Changelog to make these changes.
Majority of these changes had no visual impact on the rendered markdown, however they arguably improved code readability while also adding consistency to how they were written inside markdown.
Changes with visual impact:
Other possible changes to build on
CHANGELOG.md does not exactly follow Keep a Changelog, as its missing the "unreleased" section at the top as well as links on every version number showing the GitHub diff comparison between that version and the previous. This could also be done in the future if possible/appropriate.
Side Note
This is my first time making a contribution to a repository outside of academia and personal projects. Sorry in advance if I did anything incorrectly and please let me know what I should/could have done!