Improve development instructions in Readme file #4770
Merged
+7
−3
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.
Contribution checklist
Brief description
This change improves troubleshooting instructions for developers who encounter build issues.
For context, when I did
git bisect
and ran into numerous unexpected build issues when switching from one git revision to another and then attempting to build the project, error example:In order to resolve them I tried multiple action including:
rush build --clean
./var/lib/docker/
directory.rush rebuild
andrush purge
.The last action turned out to be the only action that reliably overcame unexpected build issues for me.
Moreover, I believe that the existing advice to run
rush build --clean
is misleading because the cache is still used according to the output of this command:This Readme update is useful for new developers because it may save them a lot of time if they run into the same problems like I did.
Checklist
(all boxes are checked as N/A for a documentation change)
Related issues
#4757
Contributor requirements