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

Update link to Godot list #1936

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Conversation

ClarkThyLord
Copy link
Contributor

https://github.com/godotengine/awesome-godot

Updating Awesome Godot list link from the now unmaintained Calinou one to the godotengine maintained one

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 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.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List.
    • 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 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.
  • 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.
  • 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.
  • Doesn't use hard-wrapping.
  • Doesn't include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.
  • Doesn't 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.

Update Awesome Godot list link to the godotengine maintained one
@ClarkThyLord
Copy link
Contributor Author

unicorn

@hodovani
Copy link

Hi @ClarkThyLord ,
in order to accept this PR, you have still to perform the following tasks:

  • You have to review at least 2 other open pull requests.

Please have a look at this section in your PR.

image

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

@ClarkThyLord ClarkThyLord changed the title Update Godot Add Godot Jan 23, 2021
@ClarkThyLord
Copy link
Contributor Author

Okay, I changed the name of the pull request to Add Godot, even though it's an update to a already linked list.

And here are the pull request I commented in: #1928 #1896

@mehdihadeli
Copy link

@ClarkThyLord Hi, I did a lint command on your repository with this command awesome-lint https://github.com/godotengine/awesome-godot and it has some breaking rules. I think you should first resolve these issues.

  README.md:3:1
  ×    3:1    https://godotengine.org                                                    remark-lint:double-link
  ×    5:117  https://godotengine.org                                                    remark-lint:double-link
  ×   12:1    ToC item "Games" does not match corresponding heading "Open Source Games"  remark-lint:awesome-toc
  ×  127:4    Invalid list item link                                                     remark-lint:awesome-list-item
  ×  128:4    Invalid list item link                                                     remark-lint:awesome-list-item
  ×  158:4    Invalid list item link                                                     remark-lint:awesome-list-item
  ×  236:59   List item description must end with proper punctuation                     remark-lint:awesome-list-item
  ×  316:3    https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools   remark-lint:double-link
  ×  317:5    https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools   remark-lint:double-link
  ×  342:96   List item link and description must be separated with a dash               remark-lint:awesome-list-item
  ×  349:4    Invalid list item link                                                     remark-lint:awesome-list-item

  11 errors

This was referenced Jan 29, 2021
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

It's looks like good, i don't use Godot but it looks good.

@cyntheticfox
Copy link
Contributor

Only a few things:

  • You might want to add the awesome-lint GitHub Action to the repository, to ensure that style is enforced.
  • Branch name isn't main.

Otherwise, looks pretty good.

@cyntheticfox cyntheticfox mentioned this pull request Mar 27, 2021
@sindresorhus
Copy link
Owner

❯ awesome-lint 'https://github.com/godotengine/awesome-godot'
✖ Linting

  README.md:3:1
  ✖    3:1    https://godotengine.org                                                    remark-lint:double-link
  ✖    5:117  https://godotengine.org                                                    remark-lint:double-link
  ✖   12:1    ToC item "Games" does not match corresponding heading "Open Source Games"  remark-lint:awesome-toc
  ✖  127:4    Invalid list item link                                                     remark-lint:awesome-list-item
  ✖  128:4    Invalid list item link                                                     remark-lint:awesome-list-item
  ✖  195:227  https://github.com/drachenfrucht1/godotcord                                remark-lint:double-link
  ✖  217:59   List item description must end with proper punctuation                     remark-lint:awesome-list-item
  ✖  270:3    https://github.com/drachenfrucht1/godotcord                                remark-lint:double-link
  ✖  304:3    https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools   remark-lint:double-link
  ✖  305:5    https://marketplace.visualstudio.com/items?itemName=geequlim.godot-tools   remark-lint:double-link
  ✖  330:96   List item link and description must be separated with a dash               remark-lint:awesome-list-item
  ✖  337:4    Invalid list item link                                                     remark-lint:awesome-list-item

  12 errors

https://github.com/sindresorhus/awesome-lint

@sindresorhus
Copy link
Owner

Bump

@Calinou
Copy link
Contributor

Calinou commented Aug 13, 2021

For the record, godotengine/awesome-godot is the new official source for awesome-godot. I transferred Calinou/awesome-godot to godotengine/awesome-godot, so this should be fine to merge.

I'll look at fixing the issues in the awesome-godot repository itself.

@Calinou
Copy link
Contributor

Calinou commented Aug 15, 2021

I fixed all the issues reported by awesome-lint with godotengine/awesome-godot@6c99993.

❯ npx awesome-lint
npx: installed 348 in 6.935s
✔ Linting

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.

7 participants