verb-generate-readme icon indicating copy to clipboard operation
verb-generate-readme copied to clipboard

create `standard-readme` layout

Open tunnckoCore opened this issue 8 years ago • 11 comments

I'm going to major standardizing and my flow would soon be totally automated, crazy and awesome. I'm using the "standards" - standard, semantic releasing with standard-version (which is almost the same as semantic-release), and wanna have standard readmes too.

offtopic: What I imagine:

  1. generate-repo - creates repo on github, labels, sync travis/coveralls site? etc, init and possibly first commit
  2. generate project - creates any templates
  3. writing the modules
  4. verb
  5. git add --all -> git cz (commit using commitizen) -> (standard-version, not always), git push (--follow-tags, if standard-version), (npm publish, if standard-version)

tunnckoCore avatar Sep 11 '16 07:09 tunnckoCore

Yeah, I thought it was funny that you grabbed the standards org the day I dropped it. (How did you know I dropped btw?)

standard-readme

What does this mean? I'm not sure what this issue is asking for specifically

fwiw, this is all something that should be customizable by the user. We have always planned on removing most of the default templates. So I probably wouldn't want to add more. I'd rather focus on fixing whatever is preventing you from customizing the way you want

jonschlinkert avatar Sep 12 '16 23:09 jonschlinkert

Yeah, I thought it was funny that you grabbed the standards org the day I dropped it. (How did you know I dropped btw?)

Ahahah, actually, didn't know, but in most of the times we think in same way and do similar things at same time - i noticed this a couple of times, starting before 2 years or so.. It's incredible. It was the same case with @es128's glob-parent and http://ghub.io/glob2fp haha - diff 1-2 days. Anyway.

fwiw, this is all something that should be customizable by the user.

Yea, I know, but i'm thinking it would be good thing to have builting at least 3 layouts: one "standard" readme, empty and yours - nothing more. Where your current readmes are near to the spec, so it also would be great if you fix them a bit to be compliant.

tunnckoCore avatar Sep 12 '16 23:09 tunnckoCore

so it also would be great if you fix them a bit to be compliant.

How about if we fix the spec instead

jonschlinkert avatar Sep 12 '16 23:09 jonschlinkert

I'm not forcing you to do it :laughing:. I'm just asking to have builtin layout which users can use without doing so much and this will help standard-readme to grow. :)

edit: And it looks good. I also don't like some of the stuff, but not so big deal, so I'm trying to convert my readmes to it.

tunnckoCore avatar Sep 13 '16 00:09 tunnckoCore

I looked at standard-readme, there is nothing there...? What am I missing?

jonschlinkert avatar Sep 13 '16 00:09 jonschlinkert

https://github.com/RichardLitt/standard-readme? spec.md

tunnckoCore avatar Sep 13 '16 00:09 tunnckoCore

was he one of the people in that discussion about standardizing readmes?

jonschlinkert avatar Sep 13 '16 00:09 jonschlinkert

Yea.

tunnckoCore avatar Sep 13 '16 00:09 tunnckoCore

I just looked. I have zero interest in supporting that. I tried commenting in the one discussion and the response(s) to my comment were childish, and it seemed like they were actively discouraging others from commenting. Someone even commented that they didn't like my style of readmes. That's fine, but given that I have more of them, more experience writing them, and more tools for creating them than any other GitHub user to my knowledge, I would have at least hoped to be a part of the discussion.

I even commented that my decisions are based on data, and someone had a problem with that. It was lame. I have 300 million downloads a month to guide my decisions, not to mention the clicks that we track. It's absurd for someone to not want insight from that.

jonschlinkert avatar Sep 13 '16 00:09 jonschlinkert

@jonschlinkert hey, really sad to hear that was your experience. Can you point to that conversation? I don't recall seeing your comment, and I am 100% in favor of data-driven workflows.

RichardLitt avatar Oct 09 '16 22:10 RichardLitt

@RichardLitt thanks for the comment. I now can't recall where that was, but I'll add the link here if I remember.

jonschlinkert avatar Oct 09 '16 23:10 jonschlinkert