Enhance README.md with KDL patching guidelines and documentation #2317
Conversation
This file contains hidden or 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
Contributor
|
Thanks for the PR! This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged. |
Added mention of 'mdn.json' to README.
* Merged notes, structure/parsing and how-to section. Note that we don't "parse KDL" here but rather convert the result. We use third party library for parsing. * Revised the purpose and split it into when-to and when-not-to. * Removed mentions of json/jsonc, I think it should be clear from this doc that we want patches in KDL and not in other ways.
Collaborator
|
@Bashamega any feedback on my edit? |
Contributor
Author
|
It looks great @saschanaz |
Collaborator
|
Cool, LGTM |
Contributor
|
Merging because @saschanaz is a code-owner of all the changes - thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.