Skip to content
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 Pinned Gists #1554

Merged
merged 1 commit into from May 14, 2019

Conversation

Projects
None yet
3 participants
@matchai
Copy link
Contributor

commented Apr 17, 2019

https://github.com/matchai/awesome-pinned-gists

Pinned Gists are a recently added feature to GitHub, allowing you to pin Gists to your GitHub profile, previewing either the first few lines of text in the Gist, or the image within it. This repo is meant to showcase tools used to dynamically update pinned Gists with content.

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

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • You have to review at least 2 other open pull requests. Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration.
  • I have read and understood the instructions for creating a list.
  • This pull request has a descriptive title in the format Add Name of List (Example: Add Swift), not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the project/theme of the list. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell., not - [Fish](…) - Resources for Fish..
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • If you use a license badge, it should be SVG, not PNG.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.

Go to the top and read it again.

@matchai matchai changed the title Add Awesome Pinned Gists Add Pinned Gists Apr 17, 2019

@kaymccormick

This comment has been minimized.

Copy link

commented Apr 19, 2019

I looked at the list, but its unclear to me what exactly the list is about. I am a moderate github user but have not explored all the various functionality.

I thought that initially the list was about other peoples gists they have pinned, which are awesome - which seemed to broad. Is the list instead about software and resources for pinned gists? This was unclear to me and could perhaps be surfaced a bit more.

Other than that, I would like to see maybe more verbiage on the list and perhaps more entries?

@matchai

This comment has been minimized.

Copy link
Contributor Author

commented Apr 22, 2019

I updated the original issue to contain a little more detail.
The intent is to create a list of open source tools for adding dynamically generated data to pinned gists, like in this image:

image

@kaymccormick

This comment has been minimized.

Copy link

commented Apr 23, 2019

Great - that was a minor nitpick, either because I wasn't thorough or because you nailed all of the requirements. I'll do another full review, but on a cursory glance it looks good. Hopefully another engineer can also do a review.

It is a lot more clear now about the intention of the list from the drop. Great idea and nice work.

@sindresorhus

This comment has been minimized.

Copy link
Owner

commented May 9, 2019

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@matchai

This comment has been minimized.

Copy link
Contributor Author

commented May 9, 2019

@sindresorhus I've carefully reviewed the guidelines and have fixed the points that needed fixing. 🙂

@sindresorhus

This comment has been minimized.

Copy link
Owner

commented May 13, 2019

The description starts with an uppercase character and ends with a period.

@matchai

This comment has been minimized.

Copy link
Contributor Author

commented May 13, 2019

The description starts with an uppercase character and ends with a period.

Ah gotcha! 🤦‍♂
I've gone ahead and updated the descriptions to include periods.

@sindresorhus sindresorhus merged commit cf3bacc into sindresorhus:master May 14, 2019

@sindresorhus

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.