[Issue-41] Update README #49
Merged
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
mpospese
requested review from
WestonHanners,
sanjibchakraborty,
devkaranCT,
karthikyml,
SahilSainiYML and
dharmik-yml
Closed
dharmik-yml
reviewed
Mar 9, 2023
dharmik-yml
approved these changes
Mar 9, 2023
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.
Introduction
Our README is missing a few key items (see Issue #41 for a full list).
Purpose
Update README with more complete documentation.
Fix #41
Scope
Discussion
I also took this opportunity to hide the pull request template file. It doesn't need to sit top-level in our repo.
📈 Coverage
Code and documentation coverage remain unchanged (both at 100%) since this was just changes to the README and adding extra comments (none removed).