New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a link to Yeoman generator for awesome lists #847

Merged
merged 1 commit into from Mar 7, 2017

Conversation

3 participants
@dar5hak
Contributor

dar5hak commented Dec 20, 2016

I wrote this Yeoman generator to make it easy to get started building an awesome list, and thought maybe the readers of this doc might find it useful. The generated directory structure looks like this.

Is it okay to add it here?

By submitting this pull request I confirm I've read and complied with the below requirements.

Failure to properly do so will just result in the pull request being closed and everyone's time wasted. Please read it twice. Most people miss many things.

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title. For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should include a short description about the list project/theme (not the list itself), and should be added at the bottom of the appropriate category.
  • The list I added
    • has been around for at least 30 days,
    • is the result of hard work and is the best I could possibly produce,
    • is a non-generated Markdown file in a GitHub repo,
    • is not a duplicate,
    • includes a succinct description of the project/theme at the top (example),
    • includes a project logo/illustration (whenever possible) at the top right of the readme (example). (The logo should link to the project website or any relevant website. The logo should be high-DPI, so set it to maximum half the width of the original image.),
    • only has awesome items with descriptions (Awesome lists are curations of the best, not of everything),
    • contains the awesome badge on the right side of the list heading,
    • has a Table of Contents section named Contents as the first section,
    • has an appropriate license (Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc) (If you use a license badge, it should be SVG, not PNG),
    • has contribution guidelines,
    • doesn't include a Travis badge,
    • has been checked for inconsistent formatting, spelling, and grammar:
      • Each link description starts with an uppercase character and ends with a period.
      • Drop all the A / An prefixes in the descriptions.
      • Consistent naming. For example, Node.js, not NodeJS or node.js.
Add a link to Yeoman generator for awesome lists
I wrote this Yeoman generator to make it easy to get started building an awesome list, and thought maybe the readers of this doc might find it useful. The generated directory structure looks [like this](https://github.com/dar5hak/generator-awesome-list/tree/master/app/templates).

Is it okay to add it here?
@aleksandar-todorovic

This comment has been minimized.

Show comment
Hide comment
@aleksandar-todorovic

aleksandar-todorovic Dec 21, 2016

Seems to me like it has pretty sane defaults. Leaving the decision up to someone else, but I quite like this and appreciate the effort you've put into it!

aleksandar-todorovic commented Dec 21, 2016

Seems to me like it has pretty sane defaults. Leaving the decision up to someone else, but I quite like this and appreciate the effort you've put into it!

@sindresorhus

This comment has been minimized.

Show comment
Hide comment
@sindresorhus

sindresorhus Jan 16, 2017

Owner

Good idea, but please make sure it actually follows the guidelines. There are multiple things it doesn't follow correctly. It should also create the Contents section and maybe also a dummy section with dummy content to show how to properly format it.

Inspired by the awesome list thing. - Drop this.

Owner

sindresorhus commented Jan 16, 2017

Good idea, but please make sure it actually follows the guidelines. There are multiple things it doesn't follow correctly. It should also create the Contents section and maybe also a dummy section with dummy content to show how to properly format it.

Inspired by the awesome list thing. - Drop this.

@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Jan 17, 2017

Contributor

Sure thing. I'll comment back here in a day or two.

Contributor

dar5hak commented Jan 17, 2017

Sure thing. I'll comment back here in a day or two.

@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Jan 21, 2017

Contributor

All right, how does this look?

Contributor

dar5hak commented Jan 21, 2017

All right, how does this look?

@sindresorhus

This comment has been minimized.

Show comment
Hide comment
@sindresorhus

sindresorhus Jan 29, 2017

Owner

includes a succinct description of the project/theme at the top (example),

⬆️

has an appropriate license (Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc) (If you use a license badge, it should be SVG, not PNG),

⬆️


I tried running the generator, but it exited early, before all the prompts were asked:

/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/qyXZwUqmJv
❯ yo awesome-list
? The name of your awesome list Foo

/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/qyXZwUqmJv
❯
Owner

sindresorhus commented Jan 29, 2017

includes a succinct description of the project/theme at the top (example),

⬆️

has an appropriate license (Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc) (If you use a license badge, it should be SVG, not PNG),

⬆️


I tried running the generator, but it exited early, before all the prompts were asked:

/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/qyXZwUqmJv
❯ yo awesome-list
? The name of your awesome list Foo

/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/qyXZwUqmJv
❯
@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Jan 31, 2017

Contributor

@sindresorhus

includes a succinct description of the project/theme at the top (example),

But as a generator, how do we decide what's succinct? Shouldn't it just leave that to the user? 😕

has an appropriate license

It does use CC0 in the readme.

I tried running the generator, but it exited early, before all the prompts were asked

Oh! 😮 I'll have a look tonight.

Contributor

dar5hak commented Jan 31, 2017

@sindresorhus

includes a succinct description of the project/theme at the top (example),

But as a generator, how do we decide what's succinct? Shouldn't it just leave that to the user? 😕

has an appropriate license

It does use CC0 in the readme.

I tried running the generator, but it exited early, before all the prompts were asked

Oh! 😮 I'll have a look tonight.

@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Feb 1, 2017

Contributor

I tried running the generator, but it exited early, before all the prompts were asked

Fixed in 1.3.1 🎉

Contributor

dar5hak commented Feb 1, 2017

I tried running the generator, but it exited early, before all the prompts were asked

Fixed in 1.3.1 🎉

@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Feb 15, 2017

Contributor

And now it makes sure it always complies to awesome-lint!

Contributor

dar5hak commented Feb 15, 2017

And now it makes sure it always complies to awesome-lint!

@sindresorhus

This comment has been minimized.

Show comment
Hide comment
@sindresorhus

sindresorhus Feb 18, 2017

Owner

It does use CC0 in the readme.

That's not what I was referring to. I bolded what you're missing. Please read it more closely.

Owner

sindresorhus commented Feb 18, 2017

It does use CC0 in the readme.

That's not what I was referring to. I bolded what you're missing. Please read it more closely.

@dar5hak

This comment has been minimized.

Show comment
Hide comment
@dar5hak

dar5hak Feb 21, 2017

Contributor

Ah, sorry. My bad. Fixed it.

Contributor

dar5hak commented Feb 21, 2017

Ah, sorry. My bad. Fixed it.

@sindresorhus sindresorhus merged commit 1dae836 into sindresorhus:master Mar 7, 2017

@dar5hak dar5hak deleted the dar5hak:patch-1 branch Mar 7, 2017

parinck added a commit to parinck/awesome that referenced this pull request Jul 23, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment