Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Search - "github readme"
-
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.6 -
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...6 -
A few hours ago I got notified that youtube-dl had been subjected to a DMCA takedown from the RIAA (https://github.com/github/dmca/...). I was instantly asked to mirror a known copy of the repository, but was too late to do it.. the other mirror had already been taken down as well. Coincidentally I also had to deal with an attack from 2 email spamhausen at the same time (still ongoing too, but things have settled down). As we frantically started searching for other mirrors we did find another one at https://gitea.eponym.info/Mirrors/.... I've now also mirrored both youtube-dl and NewPipe to https://git.ghnou.su/mir/youtube-dl and https://git.ghnou.su/mir/newpipe respectively.
The reason for it in the DMCA takedown is ridiculous though... There were 3 links to copyrighted videos in the readme file. Yeah.. 3 links, that's what a whole project got taken down for. Sending an email to one of the maintainers or opening an issue was clearly too much work.
If you want to participate in the mirroring process, feel free to use my mirror as a source. I find takedowns like this unacceptable and this software should remain available on the internet, until the youtube-dl developers can appeal for takedown removal or move their project elsewhere. Together we can do it!22 -
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)16 -
You’re a fucking demon if you don’t include a README.md.
Thanks you for reading my GitHub complaint.4 -
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 propaganda18 -
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.5 -
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 strangers7 -
As a follow-up to my comment on this rant: https://devrant.com/rants/1029538 I want to share with you my new project: BinToBmp!
It converts any file into a beautiful bitmap image illustrating all bytes as pixels. Each byte indicates an index to a color table (very happy bitmap makes it this simple).
Useful? No. Fun to make? Hell yeah!
Take a look at it on my github page:
https://github.com/Forside/BinToBmp
Download:
https://github.com/Forside/...
Print your favorite song and hang it on the wall or make a shirt from your latest compiled application. So many possibilities!
More infos in the readme.
Updates coming soon :)
P.S.: The image displays the converted jar.30 -
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.2 -
<sarcasm>
I was amazed by looking at the design of WordPress readme at GitHub.
It's really amazing, just as good as the WordPress websites.
Please have a look
https://github.com/WordPress/...
(And the url also makes sense)
</sarcasm>4 -
> 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.4 -
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!4 -
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.2 -
"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 day1 -
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... -
Hey everyone, cozyplanes here with another quick excel prank i thought of.
It is called TEEST, and the technique behind is simple, but interesting. Recommend taking a look, and pranking with your friends.
The following is the README of TEEST (Text in Excel Every Single Time) in Github.
You can check the simple project here ( https://github.com/cozyplanes/teest )
Disclaimer: Do not use or modify neither the program or the source code to make software violating the law.
### How do I use it?
1. Head to https://github.com/cozyplanes/teest and download the latest release `EXE` file.
1. Windows may warn you with the missing signature. The file is a DEBUG file, so there isn't a publisher signature. You can proceed downloading anyway since it has been virus checked by the developer.
2. Type the message you want to display in the textbox.
3. Click `Save text` button.
5. To check the file, click `Cancel` button in the opened popup dialog.
### What happens?
When an MS Excel file (`.xlsx`) has been opened, by using TEEST, two files gets opened.
1. The original file user opened
2. Excel file named `message.txt` with the custom message you have written.
`message.txt` excel file will open every single time a person opens a excel file.
*In some older versions of Excel, the message may overlap with the user opened file.*
### Why does this happen?
When MS Excel program is executed, it is programmed to check the files in the following 2 folders.
- `C:\Program Files\Microsoft Office\Office[versionnumber]\XLSTART`
- `C:\Users\%username%\AppData\Roaming\Microsoft\Excel\XLSTART`
In normal conditions, there is no file in those folders (or the folders doesn't exist at all) but when you use TEEST and click `Save text` button, it saves `message.txt` file in the folders above. From MS Excel is executed again, it will find out there is a file in the folders above, so it will show those text files in Excel.
### Where is this technique used?
There should be a lot of software using this trick, but it is widely known for ransomwares such as `GandCrab` and `TeslaCrypt` displaying decryption methods in MS Excel by this trick.
### How can I disable it?
1. Open TEEST again.
2. Click `Save text` button and click `Cancel` in the following popup.
3. Delete `message.txt` file in the opened explorer.
### LICENSE
This software is under the MIT License. Refer to the `LICENSE` file for more information.
### Contact
<cozyplanes@tuta.io>
Spam/Ads not allowed. Please only send questions or concerns about the software. It may take up to 48 hours to get a reply.13 -
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.4 -
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
Devlife6 -
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 Lisp8 -
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!2 -
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
-
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.5 -
If it hasn't a README, its not opensource! Just because you put it on Github doesn't mean people can use it...5
-
Good evening programmers, IT's, devranters and memeians.
I would like to use a little bit of your collective conciousness - the hive mind if you will.
I've been working on my automation system for quite a while and I've received some exposure from non-programmers - which resulted in more questions than suggestions.
I would like to ask you guys to give me some suggestions as to what I could add to my system.. that is, if you have time..
The program in short (if you don't want to read the readme file) is an automation system scriptable in pure Lua.
It utilizes Selenium for web automations, NAudio for audio operations and Moonsharp as an interpreter.
While my tester friends say that they use it for the actual testing, I myself found it very useful in writting bots (for browser games for example).
Here's the github link: https://bit.ly/2GDu92g
Thanks a ton!
PS. Here's an unrelated image to draw your attention.6 -
I made a GitHub Action which adds a "work-in-progress" loading gif to your README. 🦄
https://github.com/RocktimSaikia/...
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 -
Finally pushed myself to complete readme and release the docker image most of our websites use.
For anyone interested, the image is open-source and available on Github, feel free to use it or suggest any improvements :)
https://github.com/Eworkssk/... -
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..9 -
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? -
I don't understand people that say
'I like the current format of the readme more'
...
What formatting??
This was the PR:
https://github.com/SakuraNoKisetsu/...9 -
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?1 -
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.2
-
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.6 -
Here is my GitHub repository where I demonstrated
1. Role Based Authentication with fake jwt and mocked backend.
2. Lazy loading and eager loading modules.
3. Data Resolvers.
4. A pretty good project structure.
Each different topic is implemented in a different branch. I just wanted to share it here.
I have also provided links to the online resources where I learned or practiced these things in Angular ( Check Readme file for more info) :)
Feel free to check.
https://github.com/Ahsan9981/...4 -
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!1
-
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.13 -
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?12 -
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.☹️26 -
Greetings everyone!
Kindly have a look into the project and drop your feedback on the same.
https://github.com/shravan20/...
Project Name: github-readme-quotes
Project Description: A Github Dynamic Quote Generator to beautify your GitHub Profile README.
Features:
1. Layout Available
2. Animations Available
3. Themes Available
4. New Quote Generated on every hit.
Hit star 🌟 if you like it.
Feel free to contribute.10 -
I know I sound stupid but I need help, I create a repo on GitHub using gh-api ```js
export async function createARepo({name,description,token}) {
const headers = {
"Authorization": `token ${token}`,
"Accept": "application/vnd.github.v3+json",
}
const {data} = await axios(
{
method: "POST",
url: "https://api.github.com/user/repos",
data: {name,description,auto_init: true},
headers
}
)
return data
// console.log(res)
}```
when I run this code it only creates an empty project with a readme but I also want to create a file with a .html extension of the project can anybody help me with how I do this?7 -
https://github.com/ilechuks73/...
its been a while I ranted on here. A lot has been happening and I'm going to take a day off to let it out on here. oh yes 😂😂😂.
the link up there is a little feature I want to implement in a bigger project. I cant seem to get the resizing feature to work in firefox. you hover over the handles in between the divs and drag to resize them but don't work in firefox. I have hosted this on github pages and the link to the page is available in the readme file. works only with a mouse.
thanks ahead.2 -
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 OK11