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 Bots #1966

Closed
wants to merge 3 commits into from
Closed

Add Bots #1966

wants to merge 3 commits into from

Conversation

bvallelunga
Copy link

[Explain what this list is about and why it should be included here]

Awesome Interview Questions
List of interview guides for each language and framework. All I am doing is updating the name as the repo has moved.

Awesome Bots
List of bots companies can use to automate the services they leverage.

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

@lodthe
Copy link
Contributor

lodthe commented Mar 11, 2021

Hi Brian, thanks for the lists!

You didn't comment on this pull request to verify that you've read all the guidelines.
Also, awesome-lint reports that there are a lot of inconsistencies for these repositories:

[$] awesome-lint https://github.com/DopplerHQ/awesome-interview-questions
✖ Linting

  README.md:575:3
  ✖    1:1    License was not detected by GitHub                                                                                               remark-lint:awesome-github
  ✖    1:1    Forbidden license section found                                                                                                  remark-lint:awesome-license
  ✖    1:1    Missing or invalid Table of Contents                                                                                             remark-lint:awesome-toc
  ✖   26:3    Invalid list item link URL                                                                                                       remark-lint:awesome-list-ite
...
[$] awesome-lint https://github.com/DopplerHQ/awesome-bots
✖ Linting

  readme.md:63:1
  ✖    1:1    License was not detected by GitHub                      remark-lint:awesome-github
  ✖    1:1    Forbidden license section found                         remark-lint:awesome-license
  ✖    1:1    Missing content headers                                 remark-lint:awesome-toc
  ✖   17:1    Main heading must be in title case                      remark-lint:awesome-heading
  ✖   60:1    Table of Contents must be the first section             remark-lint:awesome-toc
...

And I think, it's better to suggest only one repo in a pull request.

@sindresorhus sindresorhus changed the title Update Programming Interview Questions and Add Bots Add Bots Mar 12, 2021
@sindresorhus
Copy link
Owner

I have resolved the merge conflict for you.

@@ -555,7 +555,8 @@
- [Wardley Maps](https://github.com/wardley-maps-community/awesome-wardley-maps#readme) - Provides high situational awareness to help improve strategic planning and decision making.
- [Social Enterprise](https://github.com/RayBB/awesome-social-enterprise#readme) - Building an organization primarily focused on social impact that is at least partially self-funded.
- [Engineering Team Management](https://github.com/kdeldycke/awesome-engineering-team-management#readme) - How to transition from software development to engineering management.
- [Developer-First Products](https://github.com/agamm/awesome-developer-first#readme) - Products that target developers as the user.
- [Developer-First Products](https://github.com/agamm/awesome-developer-first#readme) - Products that target developers as the user.
- [Bots](https://github.com/DopplerHQ/awesome-bots#readme) - Let bots do the heavy lifting.
Copy link
Owner

Choose a reason for hiding this comment

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

The description should succinctly describe what "bots" are. It should not be a tagline.

@sindresorhus
Copy link
Owner

sindresorhus commented Mar 12, 2021

  • List header should be Awesome bots => Awesome Bots
  • There should be a description of what bots are and what the focus of the list is at the top of the list. See other Awesome lists as example. For example: https://github.com/playcanvas/awesome-playcanvas#readme
  • All entry descriptions in your list should end with a full-stop:

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

@mfkl
Copy link
Contributor

mfkl commented Jun 30, 2021

Running awesome-lint locally on https://github.com/DopplerHQ/awesome-bots shows 770 errors

full list here: https://gist.github.com/mfkl/32b9baf690e9b57642e9727ecbcb511b

@mfkl mfkl mentioned this pull request Jun 30, 2021
@sergeysova
Copy link

@bvallelunga Maybe split this PR into different ones?
It allows to review PR separately

@sergeysova sergeysova mentioned this pull request Sep 21, 2021
@@ -555,7 +555,8 @@
- [Wardley Maps](https://github.com/wardley-maps-community/awesome-wardley-maps#readme) - Provides high situational awareness to help improve strategic planning and decision making.
- [Social Enterprise](https://github.com/RayBB/awesome-social-enterprise#readme) - Building an organization primarily focused on social impact that is at least partially self-funded.
- [Engineering Team Management](https://github.com/kdeldycke/awesome-engineering-team-management#readme) - How to transition from software development to engineering management.
- [Developer-First Products](https://github.com/agamm/awesome-developer-first#readme) - Products that target developers as the user.
- [Developer-First Products](https://github.com/agamm/awesome-developer-first#readme) - Products that target developers as the user.
- [Bots](https://github.com/DopplerHQ/awesome-bots#readme) - Let bots do the heavy lifting.

Choose a reason for hiding this comment

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

Add bots platform

Like :- GitHub Bots

@Monster0506
Copy link

Hi @bvallelunga,
Make sure to run awesome-lint on awesome-bots, as several errors were found.

@sindresorhus sindresorhus force-pushed the main branch 2 times, most recently from bec7823 to 6759a87 Compare January 13, 2022 17:57
@dhondta
Copy link
Contributor

dhondta commented Jan 13, 2022

Mmmh... I approved this too quick ; I noticed on awesome-bots that it violates multiples rules from the guidelines :

  • It has a Table of Contents section named Table of Contents while it should be Contents.
  • It has a link to doppler.com before the title, I suppose for advertising for the author, DopplerHQ.
  • It does not provide a description of the list after the title.
    The rest seems fine.

Copy link

@g00sev69 g00sev69 left a comment

Choose a reason for hiding this comment

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

its good

@sindresorhus
Copy link
Owner

Closing for lack of response. Happy to add the list if the feedback is resolved. 👍

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.

9 participants