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 Hackathon #2433

Merged
merged 5 commits into from
Apr 23, 2023
Merged

Add Hackathon #2433

merged 5 commits into from
Apr 23, 2023

Conversation

loleg
Copy link
Contributor

@loleg loleg commented Nov 21, 2022

https://github.com/dribdat/awesome-hackathon

Tips and tools for running tolerant and productive hackathons. We started this list a year ago to connect with other hackathon organizers. In my opinion, hackathons are placed perfectly at the intersection of awesome "Learning" and "Security" topics.

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

  • 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. ✔️
  • You have read and understood the instructions for creating a list. ✔️
  • This pull request has a title in the format Add Name of List. ✔️
  • 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. ✔️
  • 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. ✔️
  • The suggested Awesome list complies with the below requirements. ✔️

Requirements for your Awesome list

  • Has been around for at least 30 days. ✔️
  • Don't open a Draft / WIP pull request while you work on the guidelines. ✔️
  • Run awesome-lint on your list and fix the reported issues. ✔️
  • The default branch should be named main, not master. ✔️
  • Includes a succinct description of the project/theme at the top of the readme. ✔️
  • It's the result of hard work and the best I could possibly produce. ✔️
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list. ✔️
  • The heading title of your list should be in title case format: # Awesome Name of List. ✔️
  • 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. ✔️
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though. ✔️
  • Includes the Awesome badge. ✔️
  • Has a Table of Contents section. ✔️
  • Has an appropriate license. ✔️
  • Has contribution guidelines. ✔️
  • 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. ✔️
  • 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.

@loleg
Copy link
Contributor Author

loleg commented Nov 21, 2022

unicorn

@steven2358
Copy link
Contributor

Here are a few comments:

  • Several items don't have descriptions. Although the titles are somewhat descriptive, it is recommended to add an explicit description.
  • Some items don't follow the format - [iOS](…) - Mobile operating system for Apple phones and tablets., i.e. the dash etc.

Apart from that, nice job! The list looks very useful.

PS: What is that "unicorn" thing that everybody is commenting?

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

@steven2358 steven2358 mentioned this pull request Dec 1, 2022
@loleg
Copy link
Contributor Author

loleg commented Dec 5, 2022

@steven2358 @sindresorhus

Great feedback! I've revised the list to confirm even more closely to the guidelines (I read them carefully, trust me, but there are a lot of things to think about!) In addition to revisions to the list, I have moved the location of the entry to the arguably more appropriate 'Security' section.

Please add yourself as reviewer to approve the Pull Request (top right of the page) - thanks!

@steven2358
Copy link
Contributor

Not completely there yet: "Your entry should be added at the bottom of the appropriate category."

Moved back to previous spot
@loleg
Copy link
Contributor Author

loleg commented Dec 5, 2022

🙈 Reverted back to previous location. Thx @steven2358

@loleg
Copy link
Contributor Author

loleg commented Dec 6, 2022 via email

@Symbitic
Copy link

This is my first review of an Awesome list, so I may not be the best at judging.
The categorizing seemed somewhat confusing to me, especially the subcategories for tools (which I'm not sure is necessary).
My other suggestion would be to find companies that have hackathons. I know Microsoft has one.

@Symbitic Symbitic mentioned this pull request Jan 31, 2023
@modenero
Copy link

modenero commented Feb 7, 2023

this is a fantastic list! definitely a topic that i'm very interested in, so i'm sure i'll be using it's resources in the near future.

the only "style" comment I would make is to: use > to "quote" the explanations you offer under each new section, eg.

By awesome hackathon platforms, we mean web or mobile applications that are specifically designed to run a hackathon, or which have effectively adapted for use in events of this type. They typically allow organizers to announce the schedule and topics, register participants, and document the results.

otherwise, really terrific! 👍

@modenero modenero mentioned this pull request Feb 7, 2023
@loleg
Copy link
Contributor Author

loleg commented Feb 7, 2023

Thanks @Symbitic @modenero and @andrzejsydor

I've incorporated your content and formatting suggestions.

@sindresorhus sindresorhus merged commit 94d1068 into sindresorhus:main Apr 23, 2023
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1650054808844500992

Copy link
Contributor Author

@loleg loleg left a comment

Choose a reason for hiding this comment

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

👍

@loleg loleg deleted the patch-1 branch April 25, 2023 20:23
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