docs: add Getting Started section in README
#145
Merged
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
|
This PR only involves updates to the documentation, so it won't fail any linting or tests. |
zkoppert
reviewed
Oct 17, 2023
Co-authored-by: Zack Koppert <[email protected]>
Okabe-Junya
changed the title
Quick Start section in READMEGetting Started section in README
|
Thank you for the review!! I approved your suggestion commit, and I've also updated the PR title and the "Proposed Changes" section. |
zkoppert
approved these changes
Oct 18, 2023
This was referenced Oct 18, 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.
close #142
Proposed Changes
Getting Startedsection in READMEReadiness Checklist
Is the term
Quick Startreally appropriate? There are similar expressions like:Getting StartedUsageTutorialSimple Example/Basic ExampleAuthor/Contributor
make lintand fix any issues that you have introducedmake testand ensure you have test coverage for the lines you are introducingReviewer
bug,documentation,enhancement,infrastructure, orbreaking