Enhanced installation/testing instructions and new project introduction #4263
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
Added introduction
Elaborated more on installation and testing instructions
|
@nataliehodnett is attempting to deploy a commit to the snapshot Team on Vercel. A member of the Team first needs to authorize it. |
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.
Issues
Elaborated more on installation and testing instructions to make contribution more user-friendly. I also added a project introduction to briefly summarize key components and the purpose of Snapshot.
Fixes
Explained the purpose of provided commands, explained how to customize settings under the development guide, elaborated more on how to run service locally with Docker, and added a project introduction.
Changes
I only made changes to the documentation Readme file.
To-Do
Double-check if my instructions are correct or if anything was miscommunicated.
Additional notes or considerations
None at this time