Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple APILearn More
Search - "readme"
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.15
I should just quit. I am not paid enough to deal with this pissing contest.
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.
it's good enough for now. Added a new ticket to resolve package manager confusions. (Migrate to pnpm workspaces)
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.
If you think an OOP static site developer can't handle modern JS framework, you are probably right.2
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.8
No, a 33 Page README is not the better choice.
Not for reading.
Not for writing.
Compared to a /Documentation/ folder
+ good overviews / links6
Was looking through some repositories and found this in a 2y old PR, the only PR there is and ever was in the repo..
> Best wishes for the Wednesday launch.
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..7
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.4
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.2
So I thought there might be some people here
that care about formatting and would enjoy this:
*Or people that just want to improve*
*their README / documetation I guess~*4
> Make a small PR
- Added missing license text
- Cleaned up the tiny README
> @ the author, they don't have
any other way of contacting them
> Wait more, month+
> Denied, no explanation
> Be pissed, head over to devrant13
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.5
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 :")3
I created Syzer⚡ a cli tool that updates all of your npm dependencies at one go.
The reasons behind building this: 📝
1) I personally hate updating my project dependencies manually.
2) There are other similar libraries that do the same thing but I tried one and too much config. I had to specify the package.json file to update it. then what was the point of using that library. So ended up creating one myself.
3) 'npm update' already exists I know but it does not update the package.json file with the latest version tags.
For more info on how the use the tool check it's README instructions. 👋14
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 made a GitHub Action which adds a "work-in-progress" loading gif to your README. 🦄
You can use it as a nice little placeholder especially when creating a new repo until you actually update your readme with real docs.
(It will create a new README for you repo if there isn't one already.)
ps: I wanted to learn how GitHub Actions work so learned a lot by creating this tiny action.4
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.40
There's a special place in hell for repo owners who show only the yarn option of installing in the README.2
I don't understand people that say
'I like the current format of the readme more'
This was the PR:
If one was to acquire devRant, what would the pricetag be?
And what would you change about devRant?11
#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 sank16