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 OpenID Connect #2607

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

emmanuelgautier
Copy link

@emmanuelgautier emmanuelgautier commented May 1, 2023

https://github.com/cerberauth/awesome-openidconnect

OpenID Connect with its ecosystem is quite complex now with a lot of libraries, specs, and providers. This list tried to aggregate the different existing libraries, providers, specs, and different resources to learn more about this protocol. The goal is to help a developer or a decision-maker to enter into this topic.

PR Reviewed and commented:

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

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • 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. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions. Comments pointing out lint violation are allowed, but does not count as a review.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list 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.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • 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.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • 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.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@emmanuelgautier
Copy link
Author

unicorn

@sindresorhus
Copy link
Owner

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.

@emmanuelgautier emmanuelgautier force-pushed the awesome-openidconnect branch from ba54fbc to 0d0277f Compare May 2, 2023 20:23
@emmanuelgautier
Copy link
Author

After reading the guidelines again, I am still not sure what was not followed. I add more details and rephrase some parts to improve the list.

The awesome-lint pass. If you have more insight into what is wrong with the list, I would be happy to fix it.

Copy link
Contributor

@hallvaaw hallvaaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description should be more explanatory and describe the theme of the list, not the list itself. A brief description of OpenID Connect is sufficient.

@hallvaaw
Copy link
Contributor

The letter casing and formatting in the list entry descriptions should be more consistent. For instance, you should decide between writing "Open Source" or "Open-source" and "Blog" or "blog".

@emmanuelgautier
Copy link
Author

@hallvaaw Thanks for the review. The list has been changed with some improvements.

Following the awesome repo guideline, the main description must be short so only a small description of what is OpenId Connect has been added.

@vordimous vordimous mentioned this pull request May 26, 2023
32 tasks
@emmanuelgautier emmanuelgautier changed the title Add OpenId Connect Add OpenID Connect Jun 20, 2023
@emmanuelgautier emmanuelgautier force-pushed the awesome-openidconnect branch 2 times, most recently from bc5e5cc to ddcb6fd Compare June 21, 2023 20:16
@emmanuelgautier
Copy link
Author

@sindresorhus This PR is ready, can you review it?

readme.md Outdated Show resolved Hide resolved
@yackermann
Copy link

Looks good and supper useful @emmanuelgautier!

@emmanuelgautier
Copy link
Author

unicorn

@sindresorhus
Copy link
Owner

Just commenting “looks good” or simply marking the pull request as approved does not count!

readme.md Outdated Show resolved Hide resolved
@sindresorhus
Copy link
Owner

The repo name should be awesome-openid-connect, not awesome-openidconnect.

@sindresorhus
Copy link
Owner

OpenID Connect in A curated list of awesome providers, services, libraries and resources for OpenID Connect, the identity layer on top of OAuth 2.0 application authorization protocol. should be linkified to its website. I would also like to see a more comprehensive description of OpenID Connect.

@emmanuelgautier
Copy link
Author

Thanks for you review.

Just commenting “looks good” or simply marking the pull request as approved does not count!

The PRs reviewed list has been updated in the description in order to show only those with review comments on them.

The repo name should be awesome-openid-connect, not awesome-openidconnect.

Done ✔️

OpenID Connect in A curated list of awesome providers, services, libraries and resources for OpenID Connect, the identity layer on top of OAuth 2.0 application authorization protocol. should be linkified to its website. I would also like to see a more comprehensive description of OpenID Connect.

Link has been updated to OpenID Connect Foundation website. ✔️

Description has been changed and is now more focused on what OpenID Connect is. Let me know if it sound more clear for you.

@sindresorhus sindresorhus force-pushed the main branch 2 times, most recently from cacbf42 to c05ec08 Compare April 9, 2024 14:18
@sindresorhus
Copy link
Owner

Consistent and correct naming. For example, Node.js, not NodeJS or node.js.

I'm seeing both OAuth2 and OAuth 2.0.

@sindresorhus
Copy link
Owner

The "Books" section descriptions should mention the publish year.

@sindresorhus
Copy link
Owner

#2607 (comment) was not done

@emmanuelgautier
Copy link
Author

Consistent and correct naming. For example, Node.js, not NodeJS or node.js.

I'm seeing both OAuth2 and OAuth 2.0.

Done ✔️

The "Books" section descriptions should mention the publish year.

Good idea. It will give some insight about the writing context.

Done ✔️

#2607 (comment) was not done

I should have not understand your point. Here is the current description with the link:

image

Has you can see, the description explains quickly what is OpenID Connect and when using it. The link is the official OpenID Connect Foundation url.

@yackermann
Copy link

@Marcelo-Gustavo-2012 ...soi Dora?

@sindresorhus sindresorhus force-pushed the main branch 5 times, most recently from f0658c5 to 993cee4 Compare August 8, 2024 13:04
@sindresorhus
Copy link
Owner

I should have not understand your point. Here is the current description with the link:

I'm talking about the readme description, not the repo description.

@emmanuelgautier
Copy link
Author

The main description is the same as the repository description. I’ve added more details, but I can’t add a lot more since the OpenID Connect specs cover various use cases now.

image

This PR is a year and a half old, and it seems the conversation isn’t progressing so much. It's pity, as OpenID Connect is a widely used standard, and many people are searching for resources (libs, providers, some specs, ... etc). IMHO, this list is not so bad and can help more being listed in this repository.

Anyway, It's your project, and you can take it in whatever direction you prefer. If you believe this list shouldn’t be merged for any reason, just let me know, and I’ll close the pull request to save us both time.

Copy link
Contributor

@lutzh lutzh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems a pretty exhaustive list to me. I don't see any issues, +1 for merging.

@lutzh lutzh mentioned this pull request Oct 28, 2024
33 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants