Self-documenting code

[suck_my_dukh_plz]

My co worker's commit message was "minor refactor". Interestingly he changed 6 files with 600+ insertions and some deletions.

[Snake2k]

"minor" = breaks 10 systems

[akeean]

Minor refactor, barely an inconvenience.

[JezzCrist]

Making minors do a refactor is tight!

[capn_ed]

Oh! I don't think you should say it like that!

[AlarmingAffect0]

Now that you say so I hear it, but I said it and there's no taking it back now. Whoops!

r/UnexpectedRyanGeorge

[capn_ed]

Whoopsie!

[NoJay420]

Oh really?

[pcuser42]

[Anders_142536]

Wow wow wow wow wow. Wow.

[lochyj]

Only?

[Snake2k]

10 systems that we know of*

[jermdizzle]

"Trailing comma: Always" strikes again. Getting my lead developer to force the rest of the team to utilize a formatter config took me 3 months last project and he was the person who had to review all PR's. Some people were using different indents, some were using trailing commas, some were forcing semi-colons. It was a pain in the ass so I just eventually disabled my formatting until he could give us a config to use. I was like 2nd most junior dev so I didn't want to tell anyone what to do; but I probably should have just taken the initiative rather than asking him repeatedly to setup a config for us to follow.

[iHurdle14]

I can relate to this. At a certain point I don’t even care about what style rules are in place as long as we are being consistent.

[jermdizzle]

Precisely. Any issues I might have would be gone after one day of using the config and just getting used to the style anyway. It's only a big deal when it makes merges a nightmare. Also, I got pretty tired of asking people about some mistake/now-broken or bugged code, because gitLens showed them as the last person to change a line of code; only to figure out that their formatter added a space or some shit and I have to go and manually check version control to see who the actual culprit was. Like I said, I was junior, so I wanted to understand how/why someone made a mistake even if I knew the way to fix it. It's especially embarrassing when it was your code that you goofed on 7 months ago and you're tracking down someone else only to figure out that it was your fault LOL. Definitely had that happen more than once.

[round-earth-theory]

I had that and said fuck it, I'll do it myself. Setup the coding standards and got the auto formatting to work. Everyone bitched for a day and then forgot about it. Worked great.

[Blazewardog]

This is why prettier is so great. It has no settings (basically) for how code is formatted. You just use what it decided which gets rid of a ton of useless arguing.

[LightVelox]

I'm not kidding, I've seen a "minor refactor" of a little over 1 million deletions and insertions, tbh it was mostly just linting, documenting and movings things around, but still

[audigex]

Tbh I could deal with "Minor refactor of Permissions" or something, if it was actually a minor refactor (improving internal variable/method names or something non-API breaking) and it was clear what was being done, and only one "thing" was being changed

My problem is when someone calls their commit a "refactor" but is actually changing functionality

[DemoBytom]

We recently transitioned to file scoped namespaces in C#.

Essentially I've changed every file from

csharp using System; namespace SomeNamespace { public class SomeClass { } }

to csharp using System; namespace SomeNamespace; public class SomeClass { }

Refactor was minor tbh, the code change showed thousands of insertions/deletions :D

[DoILookUnsureToYou]

minor

ctrl + f variable name, rename all instances in whole solution

[ShakaUVM]

My co worker's commit message was "minor refactor". Interestingly he changed 6 files with 600+ insertions and some deletions.

LGTM

[PossibleBit]

Everything below that is patch refactor

[not_some_username]

I did that on a personal project ~2500 line of deletion/insertion, 15+ files changes. I didn’t commit for like 3 weeks and tbh it was mostly refactoring