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 Awesome Mastodon #2739

Merged
merged 2 commits into from
Oct 7, 2023

Conversation

hyperupcall
Copy link
Contributor

@hyperupcall hyperupcall commented Aug 6, 2023

url to list: https://github.com/hyperupcall/awesome-mastodon
explanation: Mastodon is a very popular decentralized platform for hosting a social networking platform. It's built on top of ActivityPub and has cemented it's legacy as an alternative social media platform since the hostile takeover of Twitter last year.

This does not add a new list; it updates the link to Awesome Mastodon. Unicorn.

The hueyy fork is reasonably popular and seems to be actively maintained.

I was somewhat confused since the PR template implies all PRs are requests for new awesome lists. Which means this pull request title is apparently invalid. I wasn't sure if reviews were necessary in this case (looking at #2459 for instructions), so I did it anyways:

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.
  • (N/A, changing/update link, not adding) [] 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.
  • 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 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.

Reviews

Closes #2724

@sindresorhus
Copy link
Owner

It still needs to follow the guidelines: https://github.com/sindresorhus/awesome/blob/main/pull_request_template.md#requirements-for-your-awesome-list

For example:

The description starts with an uppercase character and ends with a period.

@FallPaper003386
Copy link

This is all so new I could use a tutorial on all this? I'm total NOB

@hyperupcall hyperupcall force-pushed the update-awesome-mastodon branch from f616b17 to c011016 Compare August 23, 2023 15:16
@hyperupcall
Copy link
Contributor Author

hyperupcall commented Aug 23, 2023

After talking with the maintainer of the fork, it seemed clear that although they would accept most PRs that would improve compliance with awesome-lint, they would not accept all PRs, notibly the ones that "fixed" certain cases of remark-lint:double-link (for usefullness reasons).

Since fixing all awesome-lints is a hard-requirement, I made a fork and linked to that instead. I have spent time over the past 2 weeks months improving it - removing dead links, deprecated projects, crypto links, etc and will continue to do so.

For anyone reviewing on PRs, this is ready for your reviews!

Note, I will ping Sindre (with the keyword) after 30 days (as per the awesome list requirements, since this would be a new repository). The 30 day mark is September 14th.

@hyperupcall
Copy link
Contributor Author

unicorn

@hyperupcall
Copy link
Contributor Author

hyperupcall commented Oct 1, 2023

I suppose replying with the keyword sensibly doesn't ping... @sindresorhus this PR is ready.

A related question - is awesome-lists still a thing? If so, I would like to transfer my awesome-mastodon to the organization if you concur. I would also like to ask you for the permission to help maintain awesome-lists/awesome-bash; there are are various issues with the list (dead links, renamed links, improper formatting, non-compliance with awesome-lint, large issue/pr queue) that I would like to fix (and have merged). I have a lot of experience with Bash and I'm quite active on GitHub, so I think it would be a good fit.

Repository owner deleted a comment from FallPaper003386 Oct 6, 2023
@sindresorhus
Copy link
Owner

A related question - is awesome-lists still a thing?

I prefer for people to have their list on their account, because people feel more ownership then and is more likely to continue maintaining. The thinking of the org was to take over popular lists that are no longer maintained.

I would also like to ask you for the permission to help maintain awesome-lists/awesome-bash;

Invited you.

@sindresorhus sindresorhus merged commit 4e1a1fc into sindresorhus:main Oct 7, 2023
@hyperupcall
Copy link
Contributor Author

That makes sense - in that case I will keep the awesome-mastodon list on my account. Thank you for the invite - I have accepted it.

@hyperupcall hyperupcall deleted the update-awesome-mastodon branch October 7, 2023 08:41
Arthur-xu added a commit to Arthur-xu/awesome that referenced this pull request Nov 13, 2023
* Add Steam Deck (sindresorhus#2743)

* Update link to Awesome Mastodon (sindresorhus#2739)

* Add Pest (sindresorhus#2601)

* Add HPC (sindresorhus#2640)

* Update guidelines

* Add Biological Image Analysis (sindresorhus#2620)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

* Move Esolangs into "Programming Languages" section (sindresorhus#2799)

* Add Prompt Injection (sindresorhus#2734)

* Meta tweaks

* Add Complexity (sindresorhus#2389)

* Fix typo (sindresorhus#2834)

* Fix typos (sindresorhus#2835)

* Meta tweaks

---------

Co-authored-by: Francesco Sardone <francesco@airscript.it>
Co-authored-by: Edwin Kofler <edwin@kofler.dev>
Co-authored-by: Tomas Tauber <2410580+tomtau@users.noreply.github.com>
Co-authored-by: akail <andrew.a.kail@gmail.com>
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
Co-authored-by: Hallvard A. Wæhler <60000604+hallvaaw@users.noreply.github.com>
Co-authored-by: Sam Partington <sampart@github.com>
Co-authored-by: Hazana <hazanasec@gmail.com>
Co-authored-by: Diamantis Sellis <sellisd@gmail.com>
Co-authored-by: Vivek Gurudutt K <127002789+VivekGuruduttK28@users.noreply.github.com>
Co-authored-by: S A G A R <110724849+tmsagarofficial@users.noreply.github.com>
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.

awesome-mastodon orphaned
3 participants