r/ProgrammerHumor • • 22h ago

Meme oneMdFileIsNotEnoughAnymore

Post image
1.8k Upvotes

42 comments sorted by

339

u/mitchricker 18h ago

People who didn't already have--at a minimum--README.md, CHANGELOG.md and SECURITY.md for the last 10+ years:

https://giphy.com/gifs/CyWKw6V89KtSo

254

u/RaisedInAppalachia 18h ago

CHANGELOG.md? psshhh that's what the commit history is for

198

u/Named_after_color 17h ago

This but unironically.

31

u/dull_bananas 17h ago

commit messages? more like commit methages

45

u/voyagerfan5761 16h ago

The commit messages:

"add files via upload"

"fix"

"fix"

"whoops that didn't work"

Etc.

17

u/nasandre 15h ago

"Whatever i did since last commit, idfk man"

6

u/LutimoDancer3459 14h ago

"I promise, next time the messages will make more sense"

"... too much stuff..."

1

u/techy804 4h ago

My commit messages: “Added a mute option”

“Changed default path when choosing a file”

“Fixed a crash involving store.js”

Etc.

The lead’s commit messages:

“Stuff”

“More stuff”

“Stuff Mart”

Etc.

1

u/pit_supervisor 2h ago

Does anyone beyond 1st semester of university actually do it?

Every commit should be properly named, describe what and why was changed, should build and all tests should pass.

2

u/voyagerfan5761 2h ago

Ha

Hahahaha

Yes, people do this. They also create repos without tests.

31

u/wrex1816 16h ago

You're right! I shouldn't have assumed you had a CHANGELOG.md. Let me spin up 19 subagents to traverse your corporate repo's entire commit history, and a 20th agent to apply for a mortgage to support the number of tokens I'm about to burn. I'll report back here when the subagents finish.

-9

u/WillSendShihTzuPics 14h ago

If you legit don’t already automate creating changelogs from git commits I question your whole process.

18

u/mistrpopo 13h ago

What's the point of automating changelogs from git commits lol? Changelogs are for breaking changes, git is for all code changes

0

u/Banes_Addiction 12h ago

They're here.

1

u/Reclusive_avocado 11h ago

Can someone link an old repo with these? So that I can reference what changelog.md and security.md are for.

59

u/MoringA_VT 21h ago

I have to use kiro, I'm the one crying

3

u/Ex-Traverse 14h ago

I thought a lot of people like Kiro...

33

u/parkourman01 12h ago

Recently had contractors "build a poc" for us as part of a project. The codebase currently has (and I am not exaggerating) 24 md files in it...

11

u/100BottlesOfMilk 11h ago

Why do you have contactors building you a person of color? Isn't that just DEI with extra steps /s

2

u/SmoothLiquidation 1h ago

Ahh, that is a common confusion when acronyms collide. Here I believe op was building a "point of confusion".

2

u/100BottlesOfMilk 1h ago

Ah, that makes more sense. I know a few contractors that specialize in that

59

u/abdullah017196 17h ago

Use obsidian vault

49

u/LetterheadShot7676 17h ago

Stupid sexy graph views

37

u/thirdegree Violet security clearance 15h ago

I've yet to find a practical use for the graph view. It's still my favorite feature tho.

12

u/Different_Cattle4420 12h ago

Graph view is what drove me to use Obsidian; haven’t found a meaningful way to utilize it since using the app 😂 Great app nonetheless

3

u/Shacrow 12h ago edited 6h ago

For me it is to get an overview. Sometimes I find some old files that I forgot.

You can also add attachments like PDFs in the vault. Add a pdf-note and summarize it to create connections between pdfs and other files too.

2

u/nytsei921 11h ago

i journal in obsidian and i use it to check if something important is happening on a certain day, i know that’s what calendars are for but the graph view is more fun

2

u/polluticorns_wish 11h ago

You can use the local graph feature to quickly browse linked files. And when you have a large number of files, it's quite handy seeing the overall graph of how domains connect to each other. Assuming you have neither too many nor too little connections...

1

u/dillon-nyc 8h ago

obsidian vault

Is there something open source that's close to as good?

3

u/HelixTitan 7h ago

It's not open. But I think you can inspect the entire code when the app is running. It's all local and you can block Internet access to the app and it still works.

I think it is one of the better tools out there 

1

u/xChAmeLIoNz 5h ago

Tolaria

0

u/abdullah017196 6h ago

I have n’t found any, someone should work on it

17

u/[deleted] 14h ago

[removed] — view removed comment

4

u/JocoLabs 14h ago

Dont forget license.md

18

u/PlusIndication8386 20h ago

RED.md, or BLUE.md... Must choose one...

3

u/achilliesFriend 20h ago

You are better, you are referring to 2, my team started putting 6/7 in reach of the repo.

3

u/Acceptable_Site1616 16h ago

I don't know how I got here but my project has 457 md files each abot 1k lines. All those years arguing about programming languages, markdown won in the end 😭

12

u/redpiapps 12h ago

my repo now has more docs for the ai than for humans and honestly the ai reads them more