rework last step in setup.bash #47
Open
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
…ns, update wording
chessmango
reviewed
Mar 3, 2022
| if [ "yes" != "$ok" ]; then | ||
| printf "Local repo not pushed.\n" | ||
| printf "Manually push to origin/%s with \`git push --force-with-lease\`\n" "$primary_branch" | ||
| printf "Then, find TODO items with \`git grep -n TODO\` and resolve them.\n" |
There was a problem hiding this comment.
I do like this approach (git using a pager by default is very annoying) but would -C 3 still be useful here for a bit of context? No idea why -P was ever the case though :P
There was a problem hiding this comment.
I think we should omit the context lines because:
- the TODO items are mostly independent of each other
- to resolve the TODO items, the developer would have to open the file(s) anyway
- having the line numbers is enough for the developer to open a file and quickly jump to that line, and then get the context
- adding 3+3 lines of context (+ 1 line for separator) fills up the screen pretty quickly, and this makes it more difficult to see all the TODO items as a list
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.
I'm proposing a few changes to the last step in setup.bash, with rationale:
When I used this script, I had to scroll upwards to find this instruction (and the command to do it). Automating this step means that the developer won't miss it. Also, I think it's a good idea to push the local repo immediately after running the setup script, because the developer won't get confused if they edit the files / scripts later and
git pushfails.On my laptop at least,
git grepdoes not restore the screen contents after the grep results are closed. Letting the user (developer) do this for themselves gives them a chance to read the instructions before it's pushed out of the visible screen space.Please let me know if this is not the correct approach, thank you.