"Fix"
With 400 lines changed over 50 files
"updates"
“feat: stuff”
Guilty of this one myself.
I had a commit recently that was like 2000 lines changed over 6 files. Really should have been a smaller issue.
Every time I commit I have to look through git diff
, figure out what the hell I actually did, come up with something intelligent to say about jt, possibly split the commit into multiple commits if I changed multiple things, do some shuffling with git reset
and git add
...
For some reason all my personal projects are all like 4K SLoC with 50 total commits, all of which include apologies for not doing more smaller commits
There's a bigger issue than your commit message if you don't even know what you just coded and are committing.
You see, sometimes I code something, go to bed before finishing it, come back, decide not to commit because then I'd have to think of a commit message and I just want to code, start working on an unrelated feature, do that for a couple days, get distracted by life stuff and put the project down for a few weeks/months, rinse and repeat, and then I finally get around to writing a commit message because I'm about to start a huge change and I want a restore point and I'm like. Okay, it's been like 3 months since my last commit, I'm pretty sure my code can now do something it couldn't 3 months ago but come on, I can't even remember what I had for lunch last Thursday
I'm well aware this is terrible practice but I don't know how to stop doing it
Commit more often. Maybe work in a different feature branch, and don’t be afraid to commit your half-working crappy code. If it’s a personal project/fork, it’s totally acceptable to commit often with bad commit names and small unfinished changes: you can always amend/squash the commits later. That’s how I tend to work: create a new branch, work on the feature, rebase and merge (fast forward, no merge commit). Also, maybe don’t jump around working on random features :P
Jumping around to random features is how my ADHD brain works most efficiently.
Good news, TDD is methylphenidate of software development!
but...but new feature shiny
Fr tho this is all excellent advice
I just get too excited about actually implementing/fixing something (random things that I see along the way) more than commit ceremony (nobody will care about it in my project anyway other than one random guy who gave the repo a star)
Nah, I'm that guy, I gave your repo a star for the effort, but I'm not reading your history.
Just use What The Commit.
You can also create a git alias:
git config --global alias.yolo '!git add -A && git commit -m "$(curl --silent --fail https://whatthecommit.com/index.txt)"'
Now you can just type 'git yolo' to create a commit!
"Make Sure You Are Square With Your God Before Trying To Merge This"
Full send.
Well such an informative reply! Thanks mate 👍
Psst,
git add -p
What does this?
"patch mode" - Patch mode allows you to stage parts of a changed file, instead of the entire file. This allows you to make concise, well-crafted commits that make for an easier to read history.
Highly recommend throwing --patch
on any git commands you're used to using. You will have the prettiest, most atomic fkn commit, I'm serious people will love you for it.
I mean many people won't care, but the quality folk will notice and approve.
We make a singular commit per feature.
I always find this hard to follow personally.
Or just use a good IDE that makes doing atomic commits pretty natural.
Better yet, git commit -p
uuuuuuuu. and you could do -m to describe the commit.
next they'll add --push/-P.
perhaps add -r for fetch/rebase then commit.
one command to rule them all! 😈
git commit -m “changed somethings “
git push origin master
You forgot this --force
flag.
I'm too lazy, I use -f
For me, it was my boss gave me a programming task which he knew would take hours or a day or two... and then 15 minutes later tells me to "switch focus" and do a menial task that any of my five coworkers could do 🤦♂️
The usual reason would be "because coworkers"
I’m using Copilot for it right now. It works on half of the cases.
That's about 300% better than my average!
That's in any bloody workplace! Especially if there is o synergy between different teams.
Forward three hours, me using thesaurus.com to try fit the whole gist of my change into the first line.
do git commit -v
and then just summarize the diff you have in your editor in a human readable form.
Don't just summarize the content though, summarize the rationale or how things connect. I can read your diff myself to see what changed, I want to know the logical connections, the reason you did X and not Y, etc.
Or just say "stuff" and provide that context in the PR description separately, no need to overdo the commit log on a feature branch if you're using squash merges from your PR.
P1000x this.
I can read a diff.
I need to know why.
No, a code comment isn't good enough, it's out of date after the next commit.
Me trying to find ways around using the word "and" in the commit message.
git commit -m "directory_x:file_i.so: did x, y, and z; directory_x:file_ii.so: fixed t"
You should not use -m
, you should write commit body!
Why? My coworkers are barely literate and won't read anything with more than 4 or 5 words, writing a commit body would be a waste of time.
Oh god I feel so called out. I wish I paid more attention to my commit messages but I’m usually too busy fixing the directory structure and refactoring. Sigh.
Programmer Humor
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics