3 ms·
Normally people will find a Github repo in a way that gives them more context about what it’s about. For example, someone might link to this repo in an article
by skybrian 6y ago
Normally people will find a Github repo in a way that gives them more context about what it’s about. For example, someone might link to this repo in an article about machine learning.
There is always context and sometimes you don’t have it. Do you expect everything to be written in English for your benefit?
But sure, it would be nice to clarify things for random passers-by so they know it’s not the droid they’re looking for. It’s just not required to do this in every Github repo.
- fao_ 6y ago> Do you expect everything to be written in English for your benefit? I'm not even sure what you mean to say here. Is asking that the README contain a single two letter phrase reference to the subject matter, the same as expecting the entirety of the world to be written in english? Quite literally all I've stated is that if you're making something that's clearly intended to be public-facing, it's worth taking the exact ½ of a second to allow people who can't read your mind to understand what context they should read something in?
- skybrian 6y agoI’m saying that “public-facing” isn’t a simple and binary. The public is diverse. Writing something so everyone can read it is actually pretty hard. Adding two lines so that a random Hacker News reader can understand the README wouldn’t be enough for a nontechnical audience to understand it. You seem not to understand that people have different comprehension levels and the one you’re in isn’t necessary the most important one to the author.
- fao_ 6y ago> Adding two lines so that a random Hacker News reader can understand the README wouldn’t be enough for a nontechnical audience to understand it. I disagree, it would be enough for a non-technical audience, since it would give enough information for them to do *research* and find out more information.