Doc Improvement on Dev Guidance and Build Process Trouble Shooting #2357
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
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.
This PR is trying to improve the documentations for developers on where to start before contributing to the project. There are some very good instructions on how to launch and build the projects, however, in my opinion it's buried quite deeply and its location is not so obvious for a first-time contributor, it took me some time to eventually find the detailed steps on how to start and launch the project. So I have added a few paragraphs in the
README.mdandCONTRIBUTING.mdto guide new contributors on where to start with.In addition, I have added a section on trouble shooting a possible cause of a failed web package dependency build, where the dependency packages are not automatically installed when launching
Visual Studio. I have also attached a screen shot of where to look to fix the issue.Please let me know if I need to make further updates on the wordings or instructions.