Update README and Taskfile.yml for easier new-dev setup #1117
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
If the user cloned the git repo without `--recurse-submodules`, then running `task setup` will take care of the necessary step without needing to add a note to the README file (which is visible when looking at the repo on GitHub before cloning, but many people will clone the repo first and THEN look at the README).
New devs might not know that they need to change the PowerShell execution policy to allow scripts, and also might not be familiar with how to set the PATH variable on Windows. So we'll add slightly more detailed instructions to the README.
myieye
reviewed
Oct 11, 2024
| @@ -34,6 +34,8 @@ tasks: | |||
| deps: [ setup-win, setup-unix ] | |||
| cmds: | |||
| - git config blame.ignoreRevsFile .git-blame-ignore-revs | |||
| - git submodule init | |||
| - git submodule update --recursive | |||
There was a problem hiding this comment.
I think this would be a valuable addition:
Suggested change
| - git submodule update --recursive | |
| - git submodule update --recursive | |
| - git config --global submodule.recurse true |
myieye
approved these changes
Oct 11, 2024
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.
Fixes #1074 by expanding on the setup instructions in the README.
Fixes #848 by running
git submodule update --recursiveintask setup.