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 STEAM #2453

Merged
merged 2 commits into from
Jun 20, 2023
Merged

Add STEAM #2453

merged 2 commits into from
Jun 20, 2023

Conversation

RahulBirCodes
Copy link
Contributor

awesome-steam

A curated list of science, technology, engineering, art, and math (STEAM) resources to help aid students in specific classes across all grade levels or to provide curious minds with a starting point into numerous topics.

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.

  • Pull Request #2449

  • Pull Request #2448

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

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

@RahulBirCodes
Copy link
Contributor Author

RahulBirCodes commented Dec 14, 2022

@sindresorhus Fixed the link so the check runs correctly. The linting fails, but because of one error regarding the table of contents. In my case, making each section have a list on the same page would make the list unnecessarily messy and difficult to navigate through. To fix the linting issue, I can make it so that each point in the toc like science, tech, etc. links to a section on the main readme and then in each section is one link to the separate GitHub list, however that is adding unnecessary details. I understand that this is not like the usual way the lists are created, however in this case I propose allowing the current structure. I don't see any guideline that explicitly states that the full list must reside on the main readme (correct me if I'm wrong). Other than that issue, everything else completely matches the list guidelines. If you have any other suggestions on how I can structure it, please let me know!

@waleedsadek-panx
Copy link
Contributor

waleedsadek-panx commented Dec 27, 2022

@RahulBirCodes I think you can:

  • Place your entry at the bottom of the "Learn" topic
  • Change "Content" in your readme.md to "Contents" so it's matching the guideline exactly
  • In line 9 in readme.md use _ instead of ** for bold/strong

Copy link
Contributor

@waleedsadek-panx waleedsadek-panx left a comment

Choose a reason for hiding this comment

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

Add your entry to the bottom of the list as per guidelines and shorten description to be concise, objective and non-marketing as well.

waleedsadek-panx added a commit to waleedsadek-panx/awesome that referenced this pull request Dec 27, 2022
Hello Unicorn,

[Awesome Certificates](https://github.com/PanxProject/awesome-certificates#readme)

[Free computer science certifications & digital badges to earn.]

Also reviewed and commented on these PRs: [sindresorhus#2453](sindresorhus#2453 (comment)), [sindresorhus#2418](sindresorhus#2418 (review)) and [sindresorhus#2394](sindresorhus#2394 (review)).

Looking forward to be awesome,
Thanks!
waleedsadek-panx added a commit to waleedsadek-panx/awesome that referenced this pull request Dec 27, 2022
Hello Unicorn,

I've created [Awesome Certificates](https://github.com/PanxProject/awesome-certificates#readme)!

**The project's aim is to provide free computer science certifications & digital badges to earn.**

I have reviewed and commented on these PRs: [sindresorhus#2453](sindresorhus#2453 (comment)), [sindresorhus#2418](sindresorhus#2418 (review)) and [sindresorhus#2394](sindresorhus#2394 (review)).

I've also followed the guidelines and checked project with `awesome-lint` with no issues detected. 

Looking forward to be awesome,
Thanks!
@stark1tty
Copy link

This list is missing quite a few sub categories like Physical Geography. There are a few meta subject lists on Wikipedia. I feel like maybe there should be a page with these items as requested/needed as it is a large task for one person. Otherwise, exited to watch this one grow. Hoping to contribute soon. :)

@RahulBirCodes
Copy link
Contributor Author

@stark1tty I agree, there are a lot of subcategories! That's why I've been mostly trying to focus on specific school courses right now, but would be awesome to add more categories! Excited as well to see more contributions and where this can go!

@stark1tty
Copy link

Additionally, maybe there should be room (a sub header) on these subcategories for relevant awesome lists? :) I could definitely put a few relevant ones up right now for certain subjects.

@RahulBirCodes
Copy link
Contributor Author

RahulBirCodes commented Feb 13, 2023

@stark1tty Ya totally, except instead of creating a specific section just for awesome list you can just list the awesome list under the section like calculus. bio, etc. Would be awesome if you could put up a few! I don't want to make a specific section for relevant awesome lists because this content is also published on a website I created awesomeSTEAM.org which the majority of students and teachers who view the list use. In the context of the website, having a section for related awesome lists doesn't make too much sense because most teachers/students using aren't on Github.

@RahulBirCodes
Copy link
Contributor Author

RahulBirCodes commented Feb 14, 2023

@stark1tty Would be awesome though if you could add some more resources whenever you get a chance :) Would love to see more contributors!

Repository owner deleted a comment from Zackaryjacob Apr 23, 2023
@sindresorhus
Copy link
Owner

There are several unhandled pull requests: https://github.com/RahulBirCodes/awesome-steam/pulls

@RahulBirCodes
Copy link
Contributor Author

@sindresorhus I was requesting changes in those pull requests due to typos and the breadth of the of content being added. However, I have closed most that no longer fit with the updated content of the awesome list, and there are only two pull requests left requesting changes. However, since those are outdated and it has been a while without a response, I could close those as well.

@sindresorhus sindresorhus merged commit a0b0a2c into sindresorhus:main Jun 20, 2023
@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.

6 participants