this post was submitted on 08 Jul 2023
38 points (100.0% liked)
Programmer Humor
32356 readers
1105 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Hello! I'm a hobbyist in this space (scripting/coding), does anyone here have a:
I never had a team or guide or mentor and when I saw this i felt that my commits are like smoke signals describing that there's a fire. which isnt really helpful.
I tried to contribute to a python module that I use daily, my PR was so over engineered (iirc i added just 3 lines, but with tests, screenshots, CI/CD) i think to compensate for my lack of experience that I got called out ("wow this is pretty extreme just for that feature").
The gold standard, as so often, is to consult an oracle able to tell you what questions you will be asking when looking at the comment or commit in the future. Then answer those questions and write them down.
In lieu of an oracle, use your experience and best judgement.
Oh and never write whole papers to explain what you're doing, unless you're actually writing a whole paper. Instead, drop a cheeky
doi;//
URI as the only comment of the whole file to document that you're an experienced enough programmer to copy from papers instead of stack overflow.We’re lucky in that the inventors of our technology are still alive (for the most part). So we can ask them: Linus Torvalds on git commit messages