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 Scriptable #1953

Merged
merged 3 commits into from
Jul 29, 2021
Merged

Add Scriptable #1953

merged 3 commits into from
Jul 29, 2021

Conversation

dersvenhesse
Copy link
Contributor

@dersvenhesse dersvenhesse commented Feb 21, 2021

https://github.com/dersvenhesse/awesome-scriptable#readme

The iOS app Scriptable allows users to create automations in JavaScript. With the release of widgets in iOS 14 and the power of Scriptable, users created wonderful widgets which are curated in this list.

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.
  • Add LIDAR #1908 (comment), Add Sustainable Technology #1891 (comment), Awesome ZigLang #1894 (comment), Add Tiny #1902 (comment)
    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.

@dersvenhesse
Copy link
Contributor Author

unicorn

@dersvenhesse
Copy link
Contributor Author

dersvenhesse commented Feb 21, 2021

I am aware that the list contains images. I feel like the widgets are best displayed via visual and the awesome-linter doesn't seem to have anything against that. But if there is something against having images in the list, I'm going to remove those.

@ozh
Copy link

ozh commented Feb 27, 2021

The reviewing guidelines state that you shouldn't just say "looks good" but honestly, I think this PR just looks completely good, so...

@sindresorhus
Copy link
Owner

The reviewing guidelines state that you shouldn't just say "looks good" but honestly, I think this PR just looks completely good, so...

Then you find other PRs to review.

@sindresorhus
Copy link
Owner

I think the list could use with other kind of resources too, like articles, tips, etc.

Some ideas:

@dersvenhesse
Copy link
Contributor Author

Thanks for the note, I added those in a related section.

@dersvenhesse
Copy link
Contributor Author

@sindresorhus, I am sorry to bother, but is there anything for me improve to help this get merged?

readme.md Outdated Show resolved Hide resolved
@sindresorhus
Copy link
Owner

I think you need to spend some more effort on the list.

@sindresorhus
Copy link
Owner

I think the list could use with other kind of resources too, like articles, tips, etc.

@sindresorhus
Copy link
Owner

Even the list intro has multiple typos. There are tools like Grammarly if you're not a native speaker.

@sindresorhus
Copy link
Owner

The image should link to the project website or any relevant website.

This is not done.

@dersvenhesse
Copy link
Contributor Author

dersvenhesse commented May 2, 2021

I think the list could use with other kind of resources too, like articles, tips, etc.

I already added some.

Even the list intro has multiple typos. There are tools like Grammarly if you're not a native speaker.

Hopefully, those are fixed now, thanks for the hint to Grammarly.

The image should link to the project website or any relevant website.

This is not done.

I tried that, but the doubled link (as it is in the example) is yielding a linter error. I added the second link now anyhow.

@sindresorhus
Copy link
Owner

Hopefully, those are fixed now, thanks for the hint to Grammarly.

Please go through the item descriptions too.

@sindresorhus
Copy link
Owner

Bump

@dersvenhesse
Copy link
Contributor Author

dersvenhesse commented Jul 27, 2021

I already checked those with multiple tools and made some changes. Please let me know if there are any issues left.

@sindresorhus
Copy link
Owner

I already checked those with multiple tools and made some changes.

You need to comment back then. I cannot know what you do outside of this pull request.

@sindresorhus
Copy link
Owner

Scriptable is an app to automate iOS using JavaScript language.

You're missing a "the" or just drop "language".

@sindresorhus sindresorhus merged commit 9c86285 into sindresorhus:main Jul 29, 2021
@sindresorhus
Copy link
Owner

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

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.

3 participants