appdev-projects / rails-7-template

7 stars 45 forks source link

Do we want the git branch on the command line? #5

Closed bpurinton closed 1 year ago

bpurinton commented 1 year ago

image

Would we like something like:

I find it to be nice personally, but maybe just distracting for students?

Thoughts @raghubetina @jelaniwoods?

jelaniwoods commented 1 year ago

We did have something similar to this for phase II projects. IIRC it sometimes got cumbersome when students created very descriptive git branch names, but that's not the end of the world. It doesn't seem particularly useful for Phase I students, assuming they won't really use branching at all.

raghubetina commented 1 year ago

I would like to add more content in Phase 1 around Git, especially now that we're adopting the built-in vcs in VSCode and Git Lens.

So my instinct is to keep this. Maybe they'll be branching more, in which case it might be handy. If they're still not branching much, we can drop it.

bpurinton commented 1 year ago

@raghubetina to be clear "keep" as in "implement"? It's not a current feature in the docker image. That screenshot is from my local dev env

raghubetina commented 1 year ago

Ah yes, let's add it to AD1. Or, now that it's the same image for all phases, keep it from AD2.

As to its appearance, I think we should mimic the configuration in thoughtbot's dotfiles, since that's our recommended path for local installation.

jelaniwoods commented 1 year ago

As to its appearance, I think we should mimic the configuration in thoughtbot's dotfiles, since that's our recommended path for local installation.

@raghubetina from what I can tell, thoughtbot's configuration doesn't have any sort of "git dirty" marker. Is that something you think we should add?

raghubetina commented 1 year ago

As to its appearance, I think we should mimic the configuration in thoughtbot's dotfiles, since that's our recommended path for local installation.

@raghubetina from what I can tell, thoughtbot's configuration doesn't have any sort of "git dirty" marker. Is that something you think we should add?

Hm, good point. Since I use thoughtbot I guess I am not used to having that marker. Do you? Do you find it useful / do you think we should add it for students?

jelaniwoods commented 1 year ago

Do you? Do you find it useful / do you think we should add it for students?

I do have one and I find it useful for knowing if I have unstaged changes without running a command. I think it has potential to prompt students to commit more often. It might also just be annoying to them. I think there's potential, but we can always re-visit this later since the Phase I Git content is already being re-worked a lot, maybe it won't be necessary.

raghubetina commented 1 year ago

Hmm, good points. My instinct is to leave the dirty indicator off the command line because I already struggle with CLI real estate when e.g. typing a longer rails g command, and also they have tons of dirty indicators already (in the file tree, next to line numbers, etc).

bpurinton commented 1 year ago

From my POV as a more recent learner, having the dirty git marker definitely prompts me to commit more often. It's pretty small as well in terms of real estate. But I'm okay with waiting on this until I pull together new git workflow documentation, then we decide on the final contents of the command line prompt.

bpurinton commented 1 year ago

Resolved on this PR