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 Slack apps for developers #2391

Closed

Conversation

cosydney
Copy link

@cosydney cosydney commented Sep 22, 2022

https://github.com/axolo-co/awesome-slack-apps

List all the Slack apps a developers and his team might need. This list helps in making teams and individual more productive when using Slack.

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.

I have reviewed 3 new PRs. I hope my comments are enough to support being the awesome project self-sustainable.
PR 2325 => Commented.
PR 2288 => Commented
PR 2288 => Requested change
PR 2390 => Commented

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

I created an issue here: sindresorhus/awesome-lint#152
for this errors:
CleanShot 2022-09-22 at 12 31 20

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

@hallvaaw
Copy link
Contributor

hallvaaw commented Sep 22, 2022

Hi cosydney,

Nice list! I would suggest replacing the the unmatched ’ with ' instead. Also remove the trailing backslashes (\) in the contents section.

@cosydney
Copy link
Author

@hallvaaw thank you I've udpated what you mentionned

@cosydney
Copy link
Author

@sindresorhus thank you for your comment. That list is exhaustive and I might have missed some, please let me know if you see anything in particular.

@nathanosdev
Copy link

@cosydney, you are expected to read the list carefully yourself. Being able to read and adhere to the list is a test and your PR won't be merged unless you can prove that you're able to follow the guidelines. Other reviewers will help to spot small things that you've missed, but in this case you've missed some very big and important things so it would be great if you could take another look through the guidelines.

@nathanosdev nathanosdev mentioned this pull request Sep 22, 2022
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@cosydney cosydney changed the title Added Slack apps for developers Add Slack apps for developers Sep 29, 2022
@cosydney
Copy link
Author

@sindresorhus, I've made some updates hopefully I haven't forgotten anything.

readme.md Outdated Show resolved Hide resolved
@tomodachi94 tomodachi94 mentioned this pull request Oct 8, 2022
Co-authored-by: Tomo <68489118+tomodachi94@users.noreply.github.com>
readme.md Outdated Show resolved Hide resolved
@sindresorhus
Copy link
Owner

The "Awesome Slack Apps" item in the "Contents" section is moot. So is "Contents".

@sindresorhus
Copy link
Owner

You are mixing title-case and non-title-case in the section titles. Standardize on one style.

readme.md Outdated Show resolved Hide resolved
@cosydney
Copy link
Author

cosydney commented Dec 1, 2022

You are mixing title-case and non-title-case in the section titles. Standardize on one style.

I've updated that thank you

@cosydney
Copy link
Author

cosydney commented Dec 1, 2022

The "Awesome Slack Apps" item in the "Contents" section is moot. So is "Contents".

Removed them βœ…

@cosydney cosydney requested review from sindresorhus and tomodachi94 and removed request for sindresorhus December 7, 2022 09:56
@cosydney cosydney requested review from sindresorhus and removed request for tomodachi94 December 7, 2022 09:56
@satta
Copy link
Contributor

satta commented Dec 14, 2022

In general, the list looks OK to me. Formatting looks good now, it has the badge, the reviews, and so on. I think it reads well and it has shown me various Slack apps I never heard of, but that look interesting.

One possible improvement would be to include some logo or graphics, as pointed out by the requirements, but with trademark law in mind I am not sure whether anything Slack can just be used on non-Slack resources.

The linter still gives me some issues when run on the current main:

βœ– Linting

  readme.md:1:1
  βœ–   1:1  Main heading must be in title case                                                   remark-lint:awesome-heading
  βœ–  18:1  ToC item "Polls Slack Apps" does not match corresponding heading "Polls Slack apps"  remark-lint:awesome-toc

  2 errors

@satta satta mentioned this pull request Dec 14, 2022
readme.md Outdated Show resolved Hide resolved
@andldust andldust mentioned this pull request Feb 7, 2023
@sindresorhus
Copy link
Owner

Bump

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

Linting is failing

@shi-rudo
Copy link
Contributor

shi-rudo commented Aug 2, 2023

First of all, I would like to say that I like the idea of the list. As developers we use slack a lot. Even if your pull request is long ago, you could update it and improve it.

  • You should add a logo or illustration
  • Watch your title cases
  • Add a more meaningful description

@shi-rudo shi-rudo mentioned this pull request Aug 2, 2023
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.

None yet

8 participants