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 Neon #3103

Merged
merged 6 commits into from
Jul 22, 2024
Merged

Add Neon #3103

merged 6 commits into from
Jul 22, 2024

Conversation

tyaga001
Copy link
Contributor

@tyaga001 tyaga001 commented Jul 3, 2024

https://github.com/tyaga001/awesome-neon

Neon is designed for a wide range of users, from individual devs to enterprises, seeking modern, serverless Postgres capabilities. It caters to those who need a fully managed, scalable, and cost-effective database solution.]

My comments for the pull requests to be reviewed:

#3106 (comment)
#3068 (comment)
#3092 (comment)

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 of 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. It should not contain the name of the list.
    • - [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.
  • No blockchain-related lists.
  • 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 a maximum of half the width of the original image.
    • Don't include both a title saying Awesome X and a logo with Awesome X. You can put the header image in a # (Markdown header) or <h1>.
  • 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. The 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.

@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.

@tyaga001
Copy link
Contributor Author

tyaga001 commented Jul 3, 2024

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.

I double checked everything and looks ok could you please check now I'm only getting this which seems false positive.

@tyaga001 tyaga001 changed the title Add Neon - Serverless Postgres Database Add Neon Serverless Postgres Database Jul 3, 2024
@Polycarbohydrate
Copy link
Contributor

Polycarbohydrate commented Jul 4, 2024

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.

I double checked everything and looks ok could you please check now I'm only getting this which seems false positive.

image

Hello, you have not checked everything closely enough. If you go to the actions section you will see what is failing for lint for your repository.

README.md:5:1
  ✖    1:1   Main heading must be in title case                                           remark-lint:awesome-heading
  ✖    1:1   The repository should have "awesome" as a GitHub topic                       remark-lint:awesome-github
  ✖    1:1   The repository should have "awesome-list" as a GitHub topic                  remark-lint:awesome-github
  ✖    1:1   Forbidden license section found                                              remark-lint:awesome-license
  ✖    3:1   https://neon.tech                                                            remark-lint:double-link
  ✖    5:1   Unexpected character : at end of heading, remove it                          remark-lint:no-heading-punctuation
  ✖    5:1   Unexpected duplicate toplevel heading, exected a single heading with rank 1  remark-lint:no-multiple-toplevel-headings
  ✖    5:1   List can only have one heading                                               remark-lint:awesome-heading
  ✖   [17](https://github.com/sindresorhus/awesome/actions/runs/9780138353/job/27001062448?pr=3103#step:3:18):43  CONTRIBUTING.md                                                              remark-lint:double-link
  ✖   19:1   Table of Contents must be the first section                                  remark-lint:awesome-toc
  ✖   20:1   ToC missing item for "License"                                               remark-lint:awesome-toc
  ✖   31:3   https://neon.tech/                                                            remark-lint:double-link
  ✖   62:39  "’" is used without matching "‘"                                             remark-lint:match-punctuation
  ✖  110:13  CONTRIBUTING.md                                                              remark-lint:double-link
  • Additionally I do not see a single link that has a description of what it is about.
  • I see that you have a License file but it looks like you just copied and pasted the legal code into a file titled "License". - Additionally the legal code is not complete as it cuts off and attempts a markdown - hyperlink to the site to let readers read the rest which is not convenient.
  • Comments pointing out lint violation are allowed, but does not count as a review.
  • And additionally the entry should not include the name of the list. (The word Neon at the beginning of the entry.)

@tyaga001
Copy link
Contributor Author

tyaga001 commented Jul 4, 2024

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.

I double checked everything and looks ok could you please check now I'm only getting this which seems false positive.
image

Hello, you have not checked everything closely enough. If you go to the actions section you will see what is failing for lint for your repository. I run in my local and it only give this error which is false positive
image

README.md:5:1
  ✖    1:1   Main heading must be in title case                                           remark-lint:awesome-heading
  ✖    1:1   The repository should have "awesome" as a GitHub topic                       remark-lint:awesome-github
  ✖    1:1   The repository should have "awesome-list" as a GitHub topic                  remark-lint:awesome-github
  ✖    1:1   Forbidden license section found                                              remark-lint:awesome-license
  ✖    3:1   https://neon.tech                                                            remark-lint:double-link
  ✖    5:1   Unexpected character : at end of heading, remove it                          remark-lint:no-heading-punctuation
  ✖    5:1   Unexpected duplicate toplevel heading, exected a single heading with rank 1  remark-lint:no-multiple-toplevel-headings
  ✖    5:1   List can only have one heading                                               remark-lint:awesome-heading
  ✖   [17](https://github.com/sindresorhus/awesome/actions/runs/9780138353/job/27001062448?pr=3103#step:3:18):43  CONTRIBUTING.md                                                              remark-lint:double-link
  ✖   19:1   Table of Contents must be the first section                                  remark-lint:awesome-toc
  ✖   20:1   ToC missing item for "License"                                               remark-lint:awesome-toc
  ✖   31:3   https://neon.tech/                                                            remark-lint:double-link
  ✖   62:39  "’" is used without matching "‘"                                             remark-lint:match-punctuation
  ✖  110:13  CONTRIBUTING.md                                                              remark-lint:double-link
  • Additionally I do not see a single link that has a description of what it is about.- all links updated
  • I see that you have a License file but it looks like you just copied and pasted the legal code into a file titled "License". - Additionally the legal code is not complete as it cuts off and attempts a markdown - hyperlink to the site to let readers read the rest which is not convenient.- updated
  • Comments pointing out lint violation are allowed, but does not count as a review.? - pls help as most PR already reviewed. I reviewed one more PR here - Add Worlist #3092 (comment)
  • And additionally the entry should not include the name of the list. (The word Neon at the beginning of the entry.)- updated

@tyaga001 tyaga001 changed the title Add Neon Serverless Postgres Database Add Neon Jul 6, 2024
@tyaga001 tyaga001 changed the title Add Neon Add NeonDB Jul 6, 2024
@tyaga001
Copy link
Contributor Author

tyaga001 commented Jul 6, 2024

@sindresorhus Can this be merged please? Everything is fine. pls let me know if I'm still doing any mistakes.

Repository owner deleted a comment from madibaworld Jul 7, 2024
@sindresorhus
Copy link
Owner

Comments pointing out lint violation are allowed, but does not count as a review.

@tyaga001
Copy link
Contributor Author

tyaga001 commented Jul 8, 2024

Comments pointing out lint violation are allowed, but does not count as a review.

Updated comments for the pull requests to be reviewed:

#3106 (comment)
#3068 (comment)
#3092 (comment)

removed - NeonDB 
added- Neon Postgres Database
@tyaga001
Copy link
Contributor Author

@sindresorhus can we merge it now pls let me know what I should do? I updated my PR review comments.

@sindresorhus
Copy link
Owner

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

You are using both Neon, NeonDB, and Neon Postgres Database

@lucaferranti
Copy link

Hi @tyaga001 👋 ,

Great work on your list! Here a couple of small comments:

  • Have you considered adding the logo to your list? It seems that NeonDB does indeed have one: https://avatars.githubusercontent.com/u/77690634?s=200&v=4

  • You have a section called Youtube Channel but it seems to be each entry is a single video from a different channel. It's not clear to me how that section differs from Community video tutorials above, maybe the two could be merged? Alternatively, that section could point to each youtube channel of the video, if the channel has mainly neondb - related content. In this case, the section should probably be channels in plural.

@lucaferranti lucaferranti mentioned this pull request Jul 15, 2024
33 tasks
@tyaga001 tyaga001 changed the title Add NeonDB Add Neon Postgres Database Jul 17, 2024
@tyaga001
Copy link
Contributor Author

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

You are using both Neon, NeonDB, and Neon Postgres Database

Updated everywhere to "Neon Postgres Database" @sindresorhus please check if we can merge it now.

@sindresorhus
Copy link
Owner

The official project name is Neon. You should stick to that.

@tyaga001 tyaga001 changed the title Add Neon Postgres Database Add Neon Jul 17, 2024
@tyaga001
Copy link
Contributor Author

tyaga001 commented Jul 17, 2024

The official project name is Neon. You should stick to that.

Updated back to Neon @sindresorhus pls check

@sindresorhus
Copy link
Owner

You haven't updated this pull request.

@tyaga001
Copy link
Contributor Author

@sindresorhus sorry I missed it completely, now it's done and I think it's ready to merge now. please check.

@sindresorhus sindresorhus merged commit 128572f into sindresorhus:main Jul 22, 2024
1 check passed
@sindresorhus
Copy link
Owner

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.

5 participants