We have a bunch of white people in human resources that are trying to hire "diverse" people because the company sets HR diversity targets. Which is an inherently racist way of hiring someone.

I am told to interview this guy who claims to have Angular experience. Before the interview I ask to see a form that he has built in Angular. He sends me a repo which is ripped off of an open source project and has the readme and git commits removed. A quick web search shows that it isn't his work. He shows up to the interview and I find out he is from a Southern African country. I deliberately ask some questions about code that I can see he didn't write that I prepared ahead of time. He lies to me and tells me all about how he wrote it which showed me that he has no idea what the code does. I tell HR they better not hire him because he was very comfortable lying to me, and I'm confident that he doesn't understand any of the code that he showed me. I do not trust this guy and would never choose to work with him. HR lady says "Ah okay."

Today he walks in with a big grin on his face. HR lady fucking hired this guy. I can see his monitors from my desk and he spent his whole first day looking at a soccer website on his second monitor. I call up HR, "Why would you even ask me to interview him if you refuse to listen to my feedback?". Lady tells me "You need to be open minded about diversity. Probably most of the things you observed were either cultural differences or language barrier." I tell her definitely not. He lied to me multiple times, and he took credit for other people's work." She tells me that they will keep an eye on me because I'm not being open to diversity.

Are you kidding me? This white lady is literally stereotyping me as a racist because I'm white.

So this fucking HR lady called me a racist because she decided to hire someone that we shouldn't trust. Then she put this asshat on my project. Now I have to be cautious about my position because HR is "watching" my racist ass. Even though I am literally the only one on the development team that is white and speaks English as my first-language. I called a team meeting before the on-boarding is over so I can tell the other developers what is happening. We restructured our code review process so that I will never give him feedback. Then when the time comes that he slips up the "diverse" developers will kick him out so I won't be reprimanded as a "racist".

This company that I work for is a special kind of stupid.

Taught by managers who are too eager to hold "meetings which could have been emails", developers have now fully succumbed to holding "webinars which could have been a readme".

Me telling a senior dev on how to install a proprietary software:

Me: Sir, the instructions are in the readme.txt

Senior: I'm supposed to read the readme?!

Most useful readme file award goes too...

===rant

So I have been freelancing as web developer for 5 years. I was also playing basketball professionally so I was only working part-time, building websites here and there, small android apps to learn the job and I was also reading a lot to challenge my brain.

When I stopped playing basketball about a year ago, I thought I would really enjoy coding full time so I pursued a job.

With no formal education and just a basketball background on paper, in the collapsed Greek economy, as you may assume chances of landing a job are minimal.

After about 40 resumes sent I only got an internship. It was a 4 month, part-time, no pay deal, and then the company would decide if they would like to hire me later.

The company had 4 employees and they are one of the largest software distribution businesses in my area. They resell SaaS bought from a third company, bundled with installation support, initial configuration, hardware support, whatever a client may need.

I was the only one with any ability to code whatsoever. The other people were working mostly on customer support with the occasional hardware repair.

After the 4 month period they owner (small company, owner was also manager and other roles) told me that they are very happy with my work and would like to keep me part-time with minimum pay.

Just to give you and idea if the amounts of money involved, in Greece, after taxes, my salary was 240euros per month. And the average cost of surviving (rent, cheapest food possible, no expenses on anything but super basics) is about 600euros.

I told him I needed more to live and he told me ok, we will reevaluate a few months later, at the end of May 2017.

I just accepted it without having many options. The company after all was charging clients 30euros per hour for my projects so I kept thinking that if I worked a lot and delivered consistently I would get a full time job and decent money.

And I delivered. In the following months I made a Magento extension, some WordPress themes, a C# application to extract data from the client's ERP and import it to a third application, a click to call application to use Asterisk to originate calls from the client's ERP, a web application to manage a restaurant's menu and many more small projects. Whatever they asked, I delivered.

On time, version controlled, heavily documented solutions (my C# ones are not exactly masterpieces but it was my first time with the language and windows).

So when May ended I was pretty excited to hear they wanted to keep me full time. I worked hard for it, I was serious, professional, I tried a lot to learn things so I can deliver, and the company recognized that. YAY.

So the time comes to talk money. The offer was 480euros per month. Double my part-time pay, minimum wage. I asked for about 700. Manager said it's hard but I will see what I can do. So we agreed to keep the deal for June while they are working on a better offer.

During the first half of June I finished my last project, put all my work on a nice folder with a nice readme on every project's directory, with their version control and everything.

The offer never improved, so I said no deal, and as of today, I am jobless.

I am stressed as fuck and excited as fuck at the same time.

I will do my best to survive in the shitstorm that is called Greece.

Bring it on.

A repo on GitHub I'm maintaining has grown with 200k downloads / month since I started working on it a year ago. My recipe? I added an npm badge in the readme showing downloads / month and I responded to every issue and reviewed every PR. Now there's so much issues and PRs coming in that we had to add an extra maintainer, feels great! Teamwork, fuck yeah!

Not every PR got merged of course, but every single one of them got reviewed. Just being a good and friendly developer, giving back to the community that has given me so much. Some tips for you maintainers out there. If you have a popular project and no time there's always someone else who's willing to spend time on it, ask around and you will surely find someone else.

The intern again. FUUUUUUUUUUUUUCK!!!!!!!!!!!

She's now done the Laravel course my manager bought her, so now she feels she's ready to tackle a real world project. Hahahaha.

Okay, I have a project set up: Replicate a simple existing website that only has a basic header, some picture thumbnails and a footer element using Laravel. I've already installed Statamic and everything she needs as dev dependencies and made a step-by-step README.md file for her to get the site running locally on her machine. I told her to replicate the home page HTML.

She didn't read the readme file after I've told her multiple times in the past to do so. She tries to run the Laravel application without running composer update and all the other commands I listed in the readme file, and doesn't read the fucking console errors she's getting. She cloned the project into another Laravel project and her files are a fucking mess.

I am sick and fucking tired of telling my manager that she is not suited for this industry, she's just costing the company money and wasting my fucking time. I have been unable to focus for the past month and a half because of her.

She can't even fucking Google the console errors she's getting, just hopping on MS Teams asking me to help without even trying to solve it on her own.

I want to cry. Fuck this company and its stupid CULTure.

I cant live when README.md isnt complete and there are errors...

You know how some people put those little badges in their readme files in GitHub?

Well, one of my team members didn't know how to make those work correctly, so they just plastered images of them to make our repo look good. In actuality we have no coverage, no testing, no nothing...

Reading the readme of a software. Thanks for the heads up

TL;DR :

"when i die i want my group project members to lower me into my grave so they can let me down one last time"

STORY TIME

Last year in College, I had two simultaneous projects. Both were semester long projects. One was for a database class an another was for a software engineering class.

As you can guess, the focus of the projects was very different. Databases we made some desktop networked chat application with a user login system and what not in Java. SE we made an app store with an approval system and admin panels and ratings and reviews and all that jazz in Meteor.js.

The DB project we had 4 total people and one of them was someone we'll call Frank. Frank was also in my SE project group. Frank disappeared for several weeks. Not in class, didn't contact us, and at one point the professors didn't know much either. As soon as we noticed it would be an issue, we talked to the professors. Just keeping them in the loop will save you a lot of trouble down the road. I'm assuming there was some medical or family emergency because the professors were very understanding with him once he started coming back to class and they had a chance to talk.

Lesson 1: If you have that guy that doesn't show up or communicate, don't be a jerk to them and communicate with your professor. Also, don't stop trying to contact the rogue partner. Maybe they'll come around sometime.

It sucked to lose 25% of our team for a project, but Frank appreciated that we didn't totally ignore him and throw him under the bus to the point that the last day of class he came up to me and said, "hey, open your book bag and bring it next to mine." He then threw a LARGE bottle of booze in there as a thank you.

Lesson 2: Treat humans as humans. Things go wrong and understanding that will get you a lot farther with people than trying to make them feel terrible about something that may have been out of their control.

Our DB project went really well. We got an A, we demoed, it worked, it was cool. The biggest problem is I was the only person that had taken a networking class so I ended up doing a large portion of the work. I wish I had taken other people's skills into account when we were deciding on a project. Especially because the only requirement was that it needed to have a minimum of 5 tables and we had to use some SQL language (aka, we couldn't use no-SQL).

The SE project had Frank and a music major who wanted to minor in CS (and then 3 other regular CS students aside from me). This assignment was make an app store using any technology you want. But, you had to use agile sprints. So we had weekly meetings with the "customer" (the TA), who would change requirements on us to keep us on our toes and tell us what they wanted done as a priority for the next meeting. Seriously, just like real life. It was so much fun trying to stay ahead of that.

So we met up and tried to decided what to use. One kid said Java because we all had it for school. The big issue is trying to make a Java web app is a pain in the ass. Seriously, there are so many better things to use. Other teams decided to use Django because they all wanted to learn Python. I suggested why not use something with a nice package system to minimize duplicating work that had already been done and tested by someone. Kid 1 didn't like that because he said in the real world you have to make your own software and not use packages. Little did he know that I had worked in SE for a few years already and knew damn well that every good project has code from somewhere else that has already solved a problem you're facing. We went with Java the first week. It failed miserably. Nobody could get the server set up on their computers. Using VCS with it required you to keep the repo outside of the where you wrote code and copy and paste changes in there. It was just a huge flop so everyone else voted to change.

Lesson 3: Be flexible. Be open to learning new things. Don't be afraid to try something new. It'll make you a better developer in the long run.

So we ended up using Meteor. Why? We all figured we could pick up javascript super easy.Two of us already knew it. And the real time thing would make for some cool effects when an app got a approved or a comment was made. We got to work and the one kid was still pissed. I just checked the repo and the only thing he committed was fixing the spelling of on word in the readme.

We sat down one day and worked for 4 straight hours. We finished the whole project in that time. While other teams were figuring out how to layout their homepage, we had a working user system and admin page and everything. Our TA was trying to throw us for loops by asking for crazy things and we still came through. We had tests that ran along side the application as you used it. It was friggin cool.

Lesson 4: If possible, pick the right tool for the job. Not the tool you know. Everything in CS has a purpose. If you use it for its purpose, you will save days off of a project.

That moment when someone is happy because I said I read their README file ahahah
This is a guy from a big corporation I'm integrating with, I guess no one ever reads his stuff xD

Now don't get me wrong, I love the multicultural aspect of open source coding.

But for the love of everything that that is sane, please do not write the basic readme and code in English, and then write the entire documentation for the code in another language.

(Yay first rant)

Makes a logo to put in README before creating a project in VS.

Is it illegal to upload a malware(worm) written in python to GitHub? I'm serious :)

I've written a worm which I want to share with my friends (and possible future viewers). My intent is to share my experience. So that they can learn from it. What they are doing with it afterwards, shouldn't be my problem, I guess. (I will put a disclaimer warning in the Readme file of course)

I just submitted my first pull request though it was a minor addition in readme. So happy 😊

I once observed one guy and he just... lived. Without owing anybody and himself anything. With nothing to achieve and nothing to prove. Without any kind of guilt when he chose just to stay in bed and do nothing or when he couldn’t finish a readme in more than three months.

He was just living, creating digital things he kinda liked. Without seeking for approval. Without making big plans. Like a psychopath.

Just give me a link to the web font man. Oh, there isn't one? You used a font that we can't legally use? Do you understand how that works? I don't want your 300MB photoshop document. I don't want to comb through your ridiculous stack of insane layers and artboards and deal with the images you didn't bundle into the project or try and make sense out of your arbitrary spacing and random font sizes. You're not an artist, you're just a crappy visual designer handing off an unthoughtful glorified wire-frame - and now I have to sort out all the things that you were paid to do. It's really easy. 1. Pick a color, 2. Pick 2 fonts that are legal and available to use on the web, 3. build a few patterns for font sizes and weights - write them down. 4. Pick your images. Make them double the size you expect them to be on the site + put them in a folder, 5. add readme and list the font patterns and the link to the webfont, 6. quickly scribble the wire-frame out, 7. take a photo of it, 8. put it all in a folder and send it to me.

You’re a fucking demon if you don’t include a README.md.

Thanks you for reading my GitHub complaint.

Keep your fucking petition and readme only shit to yourself or those fucking petition websites, that everybody uses to fucking wipe their ass with, you fucking limp dicked piece of skunk shit

I am already fucking blocking all sorts of media not to hear about all your whiney fucking crap, now I have to also fucking endure your brainless fucking justice warrior bullshit all over github, all over rss feeds, all over fucking everywhere

go fucking get smoked by a car or go fucking overdose, for all I care, just fucking smear yourself all over a fucking wall, as long as you keep your fucking worthless opinion away from me

the fucking worst of it all is that every fucking shithead out there puts it up your face, even if you blocked a million of those fucking clones, then somebody that you follow or a website you visit, will fucking shove that shit in your face, github is not for your fucking propaganda

Holy shit. Didn't know I had to vent this out before I had revisited this shit.

Storytime!

Back in May last year, I started working on a dream project (call project X) of mine. Surprisingly it's still a novel idea and shit like this doesn't exist. Made some huge incremental changes. Added all the necessary automation pipeline stuff. Added some sick ass readme with screenshots/badges/glitz/glam.

Worked my ass of for about a month or so until I got distracted by other pending projects in need of clearances. Somewhere partway in that clearance period, I receive a mail from this "GitHub user" asking me why the development of project X had suddenly stopped.

I was a bit taken aback. Firstly because my project had ZERO stars and NO user interaction. Secondly because I hadn't encountered someone with confrontation like this since my middle-school teacher asking me for my homework.

Being the good, responsible child I am, I informed them on my situation and asked them to contribute according to the guidelines and I'd be more than happy to see this becoming a joint effort by the community.

Apparently, they were quite ecstatic to learn that my development was halted. They didn't have plans to contribute. Instead they wanted me to take down the project and stop working on it entirely.

Tough luck fucko.

Their organization had been working on something similar for longer than a couple of years. A similar open-sourced project will *apparently* ruin their market impact and I can *apparently* be sued for it.

I don't know much about open-source "laws" (and I've seen laws fuck people over) but this just seems retarded. At the moment, I'm not quite sure how to continue with the project. I'll still work on it but the fact being that I started receiving threats before stars makes me question the gatekeeping capacity of toxic market conditions (I still don't blame the person entirely. It's just really hard to keep your head above the water)

This is a one off thing but somehow it has definitely hampered my drive to work on the project (combined with the sheer amount of pending project that I've dug my grave with).

On the brighter side I've got 10 anonymous stars with zero promotion. 2 new message threads with productive insights and a person who says "I'm relying on this to work out". So not everything has gone to shit.

"If you document it, it's not a Bug - it's a Feature."

This whole github thing is only yet again revealing, how many package maintainers are a bunch of instable psychopaths and should have somebody else manage the keys

be it one guy deleting all shit from npm and breaking worldwide babel installs or now raging toddlers deleting their repos with no actual readme notice or atleast placeholder repo and telling others to do the same

jesus fucking christ, how can the same person have developed such intricate package and then be an absolute manbaby throwing shit at strangers

I am extremely particular about writing good READMEs in my repositories. I make sure that it has everything from prerequisites to run the code and tests on a new machine to how to actually run it (and the tests) and everything in between.

Despite all that I was asked questions that should have been avoided if you had seen the README.

One of these times was by a junior DevOps asking me about an error which was clearly due to him running the code without a virtual environment. Pings me with the entire stacktrace, I go to his desk and tell him to install the environment, which he does. 3 minutes later, another error message.

He was running the wrong script. I go to his desk again. Open the repository. Show him the README. Show him the section titled "To run the pipeline"!

There's a reason they're called README. You're supposed to READ them! 😑

"Hey that's nice, they added a README, I wonder what this weirdly named repo is and ..."

THIS IS AN EXAMPLE README YOU CAN EXPAND IT BY ADDING INFORMATION ON HOW TO...

"Fuck"

Pro tip for job candidates:
If you push a code challenge to a live hosting service like github pages or S3, don’t give the reviewers a link to the repo!! Instead put the link into the home page and send the reviewer only a link to the live hosted page.

Why?

Because, if you host with github pages, you’re required to use the project path as the domain root. If the reviewer pulls your project and doesn’t bother to read your readme file with the link at the top, he’ll complain that he couldn’t figure out why your project isn’t hosted from the root domain, and he’ll pass on your application.

True story.

> be me
> work on a nice project with friends: A, B and C
> joined in a bit later, but before any real progress was made + we scrap the existing code, because it was Python2 or something
> decide on a framework
> A wants to create one himself, instead of using an existing one
> we fight for a little, but let A do his thing
> 2 months later
> been waiting the whole time
> +1000 lines on github, but still not finished
> "Wouldn't it be better if we would use the normal framework?"
> "No, mine is hand-crafted for that task"
> "But it is full of bugs"
> "If you find one major bug, we'll ditch my framework"
> finds major bug
> "That's fixed, just give me a min-"
> finds another bug
> "Thats just because you don't know how to use the framework"

- Documentation inside ONE gigantic README
- Library is missing the core features we needed/those which are implemented don't work
- Both B and C were on my side from the beginning (in that we should use "Already Existing Fully Documented Popular And tested Framework Which Does Everything We Need")
> "But i dont understand this framework so explain it to me"
> send him a few code examples + a tutorial??? (dont remember if i actually sent im the tutorial before i left)
> "explain it to me, i can't understand it"
> I CANT UNDERSTAND YOUR FUCKING FRAMEWORK DUMBASS
> ragequitted the server+project

To this day i still don't know, which framework they are using..
Also that Python 2 code in the beginning was because A didnt know the difference and copied (yes by hand) the code from atom to github without testing anything.

Github README: Try the demo before getting started.

Me: Runs the demo

Demo: 96 errors with 32 warnings

VS: Run the latest build?

Me: Yes

VS: Unavailable.

Demo: (evil laugh)

Me: F### you dev!

I once worked with an obsessive tester who was bent on ‘testing’ the README file of a Software Distribution.

The README text file was in the distribution zip, so she had to unzip the thing before reading the file, however she insisted that her test result was a failure because there was no README that shows her how to unzip the distro to read the README!

I thought she was joking, but she was dead serious and escalated the ‘issue’ to the manager! I was furious, almost resigned from the project

In the end I had to suck it up and tolerated more weeks of her mindless obsession!

First git commit readme.

I should just quit. I am not paid enough to deal with this pissing contest.
Reviewer:
Need to add instructions (on readme) for installing pnmp, or if possible, have the top-level npm i install it (lol).
Also, it looks like we are no longer using lerna? If that's right, let's remove the dependency; its dependencies give some security audit messages at install.
Me:
it's good enough for now. Added a new ticket to resolve package manager confusions. (Migrate to pnpm workspaces)
Reviewer:
I will probably be responsible for automating deployment of this (I deployed the webapp on cloudflare pages and there is no work that needs to be done. "automating deployment" literally means replacing npm with pnpm). I disagree that it's good enough for now.

Imagine all readmes on github document how to install yarn/pnpm.

Lesson learned:
If you think an OOP static site developer can't handle modern JS framework, you are probably right.

Do these NPC devs even read the README of a project before spewing some dumbass stackoverflow like garbage in an issue thread?

Do your damn job. Being a good software engineer is not like TiKtOk or cHaTgPt where some "magical" answer or entertainment is spoon fed to you, do your absolute best to solve it yourself first, before causing more chaos out in the opensource world.

Just imagine this dude (ಠ∩ಠ)

I spent a *very* long time trying to work out why my README file wasn't formatting....

It didn't have a .md extension.
:/

When you proudly display that failed Travis badge in the README.

"The library you recently wrote appeared on my github feed. I haven't read all of the readme yet, but you already deserve a star for the documentation and the name" - CTO
Today was a good day

TDD.

I'm a fan of writing tests right after you write every module. I actually think it's doable.

But I'm not a big fan of traditional TDD, which is defined as: first writing the tests, making them fail, writing code until tests don't fail.

My experience with traditional TDD when writing library code is that you start with this very naive idea of what is needed, so you write classes and functions and a lot of times they look like overly simplistic pseudocode.

So what do you do? You scratch that, you delete those classes/functions several times.

I think this discovery process that your code is naive is slowed the fuck down by doing TDD.

I'd rather write a theoretical API in a readme file, then write code, and then write the tests, you can even withhold writing the tests, but never leaving them for another day, just so that you don't waste time writing tests that you're going to scratch.

There's always a time constraint, and most of us can't afford bikeshedding.

Traditional TDD feels like an esoteric thing, it tries to make programming a series of steps, it actually sounds like an infommercial.
"FOLLOW THESE 3 SIMPLE STEPS AND WRITE THE BEST CODE EVER"

No, a 33 Page README is not the better choice.

Not for reading.
Not for writing.

Compared to a /Documentation/ folder
+ good overviews / links

So I found this consulting job a while ago thinking that some extra cash while studying would be nice to have.

I meet with the guy, a researcher trying to start a business up, good for him I think, maybe we'll hit it off, continue working, why not? Except he has no clue how to write working code, all he ever did was writing matlab scripts he says, thats why he hired me he says.
Okay, fine, you do your job I do mine.

He hands me the contract, its about comparing two libraries, finding out which one is better suited for his job, cool, plots and graphs everywhere.

Except this is an unpaid job. YOU WHAT?! It's a test job. FINE. At least it'll look good on my resume.

We talk about the paid part where I'm supposed to scale the two libraries, looks good, as expected from an ML engineering perspective. It comes to payment. The dude has no idea how taxes work, says he has a set amount to pay and not a penny more. I explain with examples how taxes are paid, how you get reimbursed for them and so on. Won't budge. Screws me over.

Opens the door for other jobs I think, he'll learn next time I think and take the job.

Fast forward a month, 90% of the job done, he adds a third thing to compare. Gives a github link to a repo with 2 authors, last commit a year ago. There are links to a 404, claiming compiled jars. Fuck.

Not my first rodeo, git clone that shit, make compile, the works. The thing uses libs that ain't in no repo, that would be too easy. Run, error, find lib, remake all the things, rinse repeat.

The scripts they got have hardcoded paths and filenames for 2 year old binaries, remake that shit.

It works, at least I get a prompt now. Try the example files they got, no luck, some missing unlinked binary somewhere, but not a name mentioned. Cross reference the shit outta the libs mentioned on readme, find the missing shit, down it.

Available versions are too new, THE MOLDING NUTCRACKER uses some bug in an old version of the lib.

I give up. Fuck this. This ain't worth the money OR time. Wanker...

Developer of said repo notices the influx of activity, but then just updates the readme by saying there are bugs, not fixing.

Bro I just gave you a PR. Take the fucking PR and that will fix the bugs.

Internal mail form CIO's office:

"Thank you for being part of the internal trial for NPMe, we have decided to remove this tool in favour of Artifactory because of its support for multiple platforms and tools. We are sorry for the inconvenience, here is a link to migration scripts ..."

Migration "script" readme, please clone this repo, create file A, and B, and install these 2 dependencies.

Dependency 1:

- "install via homebrew ..."
- .... homebrew needs to update, checking for updates
- 10 mins later = Update failed, please upgrade to Ruby version 2.3
- Installs ruby version manager
- GPG signature verification failed
- Install GPG v2 + accept keys
- Install ruby version manager
- "please execute this command before running rvm"
- execute command
- "rvm install ruby-2.3"
- Install failed, please see log file
- Opens log file
- "Xcode on its own is not sufficient, please install xcode cli tools"
- Install xcode tools
- 5 minutes later -> "rvm install ruby-2.3"
- 10 minutes later "brew install jq"

Ok back to read me, "login to Artifactory, go here and copy paste XXX."

- Login to Artifactory
- Eventually find repo
- Login again to actually see credentials for some reason
- Screen doesn't match instructions in readme
- Click around
- Back to readme
- Back to artifactory
- Login again
- Execute command auth / setup command
- Copy contents to npmrc file .... now all my scoped packages are going to point to 1 specific repo

Fuck the migration, Fuck these shitty instructions, i'll set them all up again manually. See tags below for further opinions on this matter.

I opened an issue on a repo telling the owner that placing a "test passing" badge on the readme but not having other tests than an "ExampleTest" and no tests of the actual functionality is bad practice and what he thinks about updating the readme.

The result was a deletion (not close) of the issue and a ban from contributing (issues, PRs) on any of his projects.

And it was not some small "ten persons use this" project but a large boilerplate project with 2.4k github stars and over 800 forks. You would expect a little bit more professionalism of someone with that popularity.

Was looking through some repositories and found this in a 2y old PR, the only PR there is and ever was in the repo..

Ends with:
> Best wishes for the Wednesday launch.
> Steve

Steve never got an answer (on the PR at least) .. but the README links to his fork now (and no other changes have been done) .. why not just accept the PR or at least close it..

So I found some weird library included in this legacy code, didn't really get what it does and why it's there though.

Turns out there's nothing to be found on the internet about it. Absolutely nothing.

So after browsing through the directory structure a bit more I discover a README file. Hoping for answers I opened it, only to find this...

A couple of weeks ago I had an internship. I worked there with a classmate. We had a simple assignment, but since we're noobs when it comes to web applications (and because you don't learn that in school), we even had a hard time preparing.

Finally, I... I mean "we" decided to use React because it's close to the way we learned to solve problems in school. I asked him to implement a page with a date picker/calendar. I even searched for a repo that. 2 Days later he was still not able to implement it, he experimented with the code, but he
1. didn't even read the readme, just copied the tutorial expecting it to work
2. Didn't even look at the logic behind it.
3. Demanded to use this other repo with less functionality

10-30 minutes should have been more than enough. Instead, I wasted time telling him to read and code properly. He refused the second (and probably also the first), because "Why should I care? We'll be here for 3 weeks and then we're done with this"

Guess whom I'll avoid in any possible group project

I saved the README that explains how to mount the hard drive on the hard drive itself. 🙈

I've been working as a programmer for 16 years now, and would say I'm not inexperienced, so it's frustrating to feel like a noob after months at a new company when they have poor internal documentation, hundreds of repos with default readme, pretty much no use of docker, sub standard equipment and use their own weird software for deployment. It's hard to meet expectations under these conditions.

Add your fucking requirements.txt files or atleast have a decent fucking readme. I have had to implement many official repos for AI ML papers now and most of them are shit with a load of bugs in them, cant you implement them properly while you are at it?

Also would like to add most of the sota results arent honest maybe famous ones are but the research community is full of shit really. All of that cant be changed but atleast add readmes and requirements ffs.
I have to spend days just to implement your sub par result providing fuckery.
I’d rather just code it all myself sometimes

Ummm, okay......

Hi!

To Blockchain or not

Still can't find a decent node MVC framework. Thought I'd list out all my requirments and what I'd like.
Turned into a readme of me moaning about current frameworks. Not sure I want this on github

Devlife

procrastinating by getting drunk since 11:00 AM, and writing specs for my (hypothetical) language/os/platform.

feeling righteous retribution because the client made me be stressed for 3 hours due to an issue that THEY caused but for 3 hours the only info I had was "there's a critical blocker issue and we're convinced YOU caused it"

well... no... i did NOT cause the fact that you UPGRADED PHP DURING THE WEEKEND BEFORE MONDAY'S PRESENTATION TO CLIENT (while waiting for an urgent commit from me).

seriously.

also, germans. i've heard many times from other people that they're... basically racist towards us (slavic nations), thinking of us as untermensch, coal-miner peons, but I didn't realize their passive-aggressive covertly smug demanding attitude is due to this, I just assumed it's a reaction to me being incompetent.

so yesterday when we finished the call (in preparation for which I tried to switch to their "client demonstration" branch since that's where the error was, and I wanted a headstart on fixing it, ended up in a place that my today's whole-day task should be "rebuilding the DB into working condition", because there's about 10 "core" sql scripts in two different folders, which need to be run (in a very specific order, of course, which readme tells you, but what it tells you has been outdated at least for 3 months, of course), and

...THE MAIN CORE SCRIPT THAT IS THE FIRST TO RUN, THAT CREATES THE DB schema, HAS THREE SYNTAX-LEVEL typos which fail it mid-way...

...the joys of continuous deployment via scripts, I guess? I would love to challenge any person from them to screenshare to me, manual deployment of the current version from zero, and I would be willing to give the person 20% of my monthly salary if they would be able to do it within 20 minutes.

but... well...
the point is, i should be doing not entirely bullshit stuff.
but yesterday's 6 hours of being in "at full attention because it seems we fucked up" totally convinced me, that today I'm taking a break.

So I'm gonna go buy another 3 beers and continue writing the specs of my dream language/os/platform.

1. Go to Github for you
2. Download the 'codes'
3. Send them as a pdf to you when the code is there in the repo.
4. Write you a step by step tutorial when there's a clear README.

YOU LAZY MOTHERFUKCER!

There are only two kinds of open source projects:
1. Short, all-lowercase, starts with “lib”, written in C, obscure author, used by 80% of the electronic devices on earth and in space, the modern civilization as we know it will collapse immediately should this library disappear
2. Name that tells you nothing, readme has the “Philosophy” section and emojis, written in JavaScript, author has 20k Twitter followers and 50k GitHub stars. When you run it, your laptop’s coolers start spinning like crazy
3. Common Lisp

I have two contributions so far in my first hacktoberfest. I have created a readme and updated a .gitignore to ignore VSCode’s .vscode file, just in case anyone else who wanted to contribute that uses VSCode doesn’t have to worry about the .vscode file

I completed my 4 pull requests for hacktoberfest and guess what all of them got approved. Yayyy!!

So these are the issues which I fixed in hacktoberfest2019.

1. Fixed readme of imba
2. Fixed the script of devTea
3. Added screenshots for the same (2)
4. Helped a friend with a blockchain script.

Thanks a lot!! @devTea, for giving me the chance.

Thanks GitLab.

After I get notifications about the final replies to my 6 month quest of updating someones GitLab README, I didn't expect MY fork to have been modified ( and thanks to that, made ugly / they removed all spacing, vertical & horizontal )

Where the fuck even was the option that GitHub offers where it prevents people from just doing whatever to your shit in a PR?

Why the fuck isn't this a permanent setting for either ( lab & hub ) so I don't have to manually turn it off every single time.

I didn't even think about that option up until now, since the maintainers didn't touch anything and everything seemed fine, but now that it was about to be merged, they suddendly got the bright idea of squashing everything into one commit and that on my fork itself, .. really helpful.

"README.md edited online with Bitbucket"

touch README, then add README, and commit me, until I can, push to, origin master.

Made my first open source contribution today. 6 months into my degree. It was just editing a README with a proper description of the game that was created but good practice to get more familiar with the flow and usage of everything in Github.

I was temporarily involved in one project. During the handout I made sure to write a rather comprehensive readme file. Yesterday I got a message from the client asking about basically the first thing written in the readme :")

> Make a small PR
- Added missing license text
- Cleaned up the tiny README
> Wait
> @ the author, they don't have
any other way of contacting them
> Wait more, month+
> Denied, no explanation
> Be pissed, head over to devrant

assume no one updates README

spend an entire day fighting a config issue

OR

first check README

Your code is as well documented as an npm package without a readme

just found one more *DD
RDD - Readme Driven Development
Its real google around...

:D

Trying to understand other people's code like:
- 6 README, in total 7 lines (that's all there is for documentation)
- 40% of code is commentary like (original code, not altered...)
// if(a = b)
// c = d; // this is not working

If it hasn't a README, its not opensource! Just because you put it on Github doesn't mean people can use it...

Committing README typo fixes be like...

My lovely team and I inherited a legacy app written in Angular 14.
We love it when we get fucked by Pajeets like this.

We love tons of `any`-s in the codebase.
We love unreadable code with 5 levels of nested ternary operators.
We love the lack of a README on how to actually build/start the app.
We love the outdated dependencies.
And we absolutely love it when you use a paid package that costs $1755.

Recently I started coding a project for my school with two of my friends. The first one is a person which spends most of his time reading 4chan and joking about Pope, you know this kind of person. The second, Michael, is a really good partner for coding, he's just an opposite of Jedrzej, the first one. Jedrzej used to call people 'cancer' and this kind of sh**. Lately Michael said, that he's mother has breast cancer and he left our conversation on Facebook. Later I told Jedrzej, that he has to tell Michael 'sorry', but he wrote something stupid (doesn't matter what) and the situation only went wrong. At least I told them that they have to bury the hatchet and start working. The only problem here is that Michael and I made 99.7% of our project, Jedrzej only updated README and shared his VPS. I'm a full-stack dev, but our project is on laravel and I don't know what kind of sorcery is this framework so Michael does the back-end. My question to all of you who read this rant - what should I do with lazy Jedrzej?

Co-worker put up a pull-request for his work, with no build file, no readme, no gitignore, and shell scripts for running the app (but not compiling it). O_o

The guy has been using atom editor even though we have license for Intellij for everyone, which .. whatever .. if it works for you...

In our daily stand, people offered to help him add the build files and he was like, "No, I know how to do it, I was just trying to avoid using Gradle until I had to."

It just made me think, "Yea I know you have all these nice screw drivers and hammers, but I'm going to keep using my hands and this stick so I can avoid using tools until I have to."

Was just asked to review a new set of libraries that the "experts" from our contracting wing created.

I opened one and the readme lists its features as:

Features:
- Feature 1
- Feature 2
- Feature 3

and the Faq is:

- Possible question 1
- Answer to question 1

That feeling when you open link that's supposed to lead to the index of documentation and you find this...

The rest was.. unfinished..

#fml

Accidentally moving readme and pushing..

I really need to introduce unit tests.

Btw the module is meant for internal use and the readme is more for eventual collaborators than the general public

I'm burned out and yet I'm trying hard to do anything useful that I push uncompleted code in different new projects without a README file or description of any kind.

FML having to take on and support a python test framework that looks like it was written by a junior C embedded dev without a mentor.

- Imports everywhere in the code
- No abstraction or OOP
- sys.path.append fest (broken imports of course)
- Global variables fest
- No docstrings
- No readme
- Somehow mixed with a jUnit test framework as well
- Uses Windows environment variables profusely
- Pycharm has a stroke when I open files from this project

Great how I’ve just started a new job, haven’t been given all the licenses I need to run the software, there are multiple products with little to no documentation (and by none I mean the word “Architecture” is all there is in one of the main products ReadMe file) and I’ve a year of this! How is a company that’s this big not in any way documented like! This is gonna be long 😑

When you give a basic touch of modern design to a README and critize their replies they end the conversation with

'locked and limited conversation to collaborators'

'We appreciate the effort'

Sure doesn't look like it.

'X is highly specialized software'

Like most other software? And?

'The docs are fairly out of date, and need a complete rewrite, not this kind of graphical adjustment, so it would do more harm than good to present information of how to run this application in a secondary page along with random outdated info.'

So you are too lazy to update them, probably won't for a long time and have a problem with updating the outdated information's design despite that not actually changing the situation.

Disregarding the fact that the 'graphical adjustment' work even if you update the content.

Got it, right.

EN: The Amazing work on this readme! The hours they must have spent!
ES: El trabajo increíble en este Readme. Las horas que habrán usado.

Readme.md
*Todo: Add description*

>103 commits
>Last commit: a year ago
>Last commit on readme: 5 years ago

Slothful cunt, you don't deserve these 7 stars

Designing my github readme profile @shitiomatic

Today I wrote my first plugin ifor elasticsearch ... Was awsome feeling..it is cool to decorate the readme when you have written something of your own.

I wonder if anyone ( especially a highly experienced engineer ) can tell me what kind of pull requests are rude or inappropriate to do.

I saw some newbie do small fixes in docs or readme folies or some just add unnecessary lines of codes and then do a PR.

I don't know whether these are rude ones or I am thinking about it the wrong way ...
I've also attached an example ...

FML..

I worked directly in my Github repo folder while working on a project (don't ask me why). I did my initial commit with all my code from the start until 5 hours ago. I never pushed.. A minute ago, I checked my commit and noticed that there were DB credentials in one of the files. So.. Smart me.. "revert commit"..

Result. Everything got deleted except my node_modules folder and the readme file.. I lost everything.. Fuck me, I'm going home..

Please, someone.. Can I get these files back via git or something? Can't find anything in in the history..

So, i'm trying to get linkr (a pretty cool short link service) to work in a docker container since 4 hours now to host it on my server. There is no official container because it needs a working database connection and stuff during installation which can only be done via console and (for whatever reason I couldn't find out yet) need to be done while building the container. The problem is, I can't connect it to the database while building the container so there is no database during installation to create tables and stuff and the build will fail. ARGH.
Why the hell would you do this????? Theyre actually saying in their readme there is no dockerfile because the config options are specific to your configuration...?!?!
The thing is entirely written in python, so reading and parsing configfiles on the fly should not really be a problem.

Of course I could ssh into the container and run the installation script but that's not the point.

Docker is not about being lazy.
It's about portability.
Maybe I don't want to bloat my server with your 39579372639 npm dependencies? Or I don't want to install a freakin apache, because I have every other site on nginx and therefore wouldn't work with apache.

AAAAAAAARRRRRRGGHHGGGGG

in the end, I'm probably going to modify the thing to install tables when running the container and giving the first user admin rights instead of prompting to enter credentials for a new admin user.
And yet I didn't even speak python.

Me: I want a T-shirt

CodewithHarry: Register yourself at Hacktoberfest and contribute to Opensource by Making PRs on the only Readme file again and again

There's a special place in hell for repo owners who show only the yarn option of installing in the README.

Hey kids, do you want to know what's cool and hip?

Writing scripts to formalize and encode domain specific procedures related to development and sharing it within the entire team is cool!

Readmes with step-by-step guides are highly overrated.

so many rust libraries have code in the README but it isn't syntax highlighted lol

this is such a dire omen to me
like it's so basic
why did you miss it

Hey where can I get access to the devrant API? GitHub readme said it isn't officially public yet but people are still using it. Just had a few for projects I wanted to try.

Should I contribute to someone's GitHub profile readme? Or should I tell them the problems I found?
Bare in mind I don't like this person, but I respect them.

When your manager tells you to write the whole algorithm in the README

Ugh. Where to begin!

If you gotta make a standard for everyone to follow, you better make it readily available. Even though you barely have any users, but if it's a standard, anyone can try to follow it tomorrow. Or else take it down completely.

There's a standard for learning tools handled by IMSGlobal (Don't ask who they are, no idea). So if you want to build a tool to integrate with different learning platforms, follow this.

OK now, to read the documentation you have to register for an account. As if this is bad, ....... wait for it ........, sign up has to be approved by an admin. My request is already weeks old but not approved.

OK. Google around and try to see if some alternative can be read than that shitty website. Apparently, they have a Spring plugin on GitHub that can be used as a Maven dependency. It has a small readMe attached so I can get something out of it.

And I'm using Spring, golden right? Not quite...............
turns out the stupid readMe is outdated. If you follow those instructions, you get errors. WONDERFUL!!

Now I have to dig through all the code files and try to make sense of what I'm supposed to do.

What is good practice for giving recognition to some ones tutorial/project when using elements in your own project?
F.i. I would like to demonstrate I gained certain skills, hence created a github project based on some vids/forum/else. I tailored the code to my own preferences, but the foundation is based on someone elses project. I am now listing these inspirational sources in the readme or comments. But is there a general practice for this?

Hypothetically..

If one was to acquire devRant, what would the pricetag be?

And what would you change about devRant?

When you commit a more readable README on GitHub to a non native English speaker sends you an email a day later asking for help why his self-signed certificate isn't trusted by his browser or his other computers.

The project he's working on is to sniff Wi-Fi packets that are encrypted through a MiTM attack. I've now stopped following this project and moved on.

Has anyone else had any stupid questions from debs which were about the key purpose of their project and how to go about it?

Is anybody actually using Adobe DreamWeaver for web development?

I asked my co-worker/classmate to integrate a react component into a project "we" worked for the (forced) practicum. I searched and setup the example with him (or rather for him) to check whether it's working as intended.
Note, that we were both not really familiar with react and or node. I had a bit more experience and would have helped him, if he had asked. IF

I asked him regularly how he's progressing and he said he did fine. 3 days later I finished my tasks and wanted to know how far he got.

Status? Non working example project because all he did was commenting out seemingly random lines all over the only file in the example project one had to copy paste from the Readme.

Providing a nice Readme.md file with your open source project is never enough. You need to have a beautifully designed website for the documentation to go with it, oh yes sir!

Firmware updates with no README at all!

Have you built your GitHub Profile README yet?
GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile.

I thought the ReadMe file on git was for how to use someone's source code. why I find most of them empty!! 👊 😉 others jst have -----###

Nothing like constantly having to spend 3-5 days of spin up on trying to help another team with their microservices because they have such a severe lack of documentation that I can't just follow a readme to get their projects running. Instead, I have to bug one of their developers to help me get it up and running (because they use non-standard project setups and dependency management), delaying things even more. No matter how much I scream that we need documentation no one makes it a priority.
Did I mention these are microservices written in Golang and I'm a front end developer? And I'm being made to work on back end tasks because we have a crazy high attrition rate and they won't back fill the back end positions.

How can I make a bot which makes a single commit everyday at a specific time for a particular repository?
The commit can be anything like insertion in readme or creating a new file.

I tried to accomplish this using python selenium I deployed it on heroku, the problem I am facing is github doesn't allows to crawl on it so it sends a verification code to me on mail and all my further selenium actions fail due it this.☹️

Considering that Markdown exists and Readme files are rendered by default in GitLab, Github, and so on

Why devs insist on documenting stuff on Confluence?

README.md, is there any way in bitbucket/stash to customize the index markdown to be rendered other than README.md?

During a training reading a Readme file:

Copy paste the following code in the editor.
NOTE: REPLACE ALL SPACES WITH TABS OR IT WILL BREAK

Can I edit my npm package (typo in readme) after publishing. If yes, how?

Don't you love it when a module maintainer replay for install instruction is "If there any specific things you think should be improved in the README or the help, please file a patch :)" What a dumb fuck you have to be to act that way??

Is this me or web developers never ever document their library?

I'm coming from the mobile dev world ans from what I've seen so far 8/10 mobile librairies got a well documented readme with some examples, etc.

I'am looking for web (php) librairies and no one give a fuck explaining what its shity library do and I never ever saw librairies with screenshots or gifs to give some examples...

I WON'T DOWLONAD YOUR SHITTY LIBRARY IF I DON'T EVEN KNOW WHAT IT DOES...

GitHub: merge conflict in the readme document.
Me: I don’t care just skip it
GitHub: no go just use git to fix it
Me: I DONT WANT TO? CAN YOU JUST ADD SKIP IT OK

The only commit in a repo without revision is the firt one!
And that one adds a barely empty README file!!

Doing what I dislike... documentation.

and I have to make the readme files for every directory within the codebase.!!

#Suphle Rant 2: Michael's obduration

For the uninitiated, Suphle is a PHP framework I built. This is the 2nd installment in my rants on here about it.

Some backstory: A friend and I go back ~5 years. Let's call him Michael. He was CTO of the company we worked at. After his emigration, they seem to have taught him some new stack and he needed somewhere to practise it on. That stack was Spring Boot and Angular. He and his pals convinced product owner at our workplace to rebuild the project (after 2+ years of active development) from scratch using these new techs. One thing led to the other, and I left the place after some months.

Fast forward a year later, dude hits me up to broach an incoming gig he wants us to collab on. Asks where I'm at now, and I reply I took the time off to build Suphle. Told him it's done already and it contains features from Spring, Rust, Nest and Rails; basically, I fixed everything they claimed makes PHP nonviable for enterprise software, added features from those frameworks that would attract a neutral party. Dude didn't even give me audience. I only asked him to look at the repo's readme to see what it does. That's faster than reading the tests (since the docs are still in progress). He stopped responding.

He's only the second person who has contacted me for a gig since I left. Both former colleagues. Both think lowly of PHP, ended up losing my best shot at earning a nickel while away from employed labour. It definitely feels like shooting myself in the foot.

I should take up his offer, get some extra money to stay afloat until Suphle's release. But he's adamant I use Spring. Even though Laravel is the ghetto, I would grudgingly return to it than spend another part of my life fighting to get the most basic functionality up and running without a migraine in Spring. This is a framework without an official documentation. You either have to rely on baeldung or mushroom blogs. Then I have to put up with mongodb (or nosql, in short).

I want to build a project I'm confident and proud about delivering, one certified by automated tests for it, something with an architecture I've studied extensively before arriving at. Somewhere to apply all the research that was brainstormed before this iteration of Suphle was built.
I want autonomy, not to argue over things I'm sure about. He denied me this when we worked together. I may not mind swallowing them for the money, but a return to amateur mode in Spring is something I hope I never get to experience soon

So, I'm wondering: if his reaction reflects the general impression PHP has among developers globally, it means I've built a castle on a sinking ship. If someone who can vouch for me as a professional would prefer not to have anything to do with PHP despite my reassurance it'll be difficult to convince others within and beyond that there could be a more equipped alternative to their staple tool. Reminds me of the time the orchestra played to their deaths while the titanic sank

Am I the only one that cringes when they see the word "scale" mentioned on a software product's documentation/README?