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 Shopware #1469

Closed
wants to merge 1 commit into from
Closed

Add Shopware #1469

wants to merge 1 commit into from

Conversation

shyim
Copy link

@shyim shyim commented Nov 29, 2018

Shopware Awesome List

List here

Introduction

Shopware is a opensource eCommerce System written in PHP. That list contains nice extensions, themes and other examples for Shopware which i review myself.

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

Yes!

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

  • 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.
  • I have read and understood the instructions for creating a list.
  • This pull request has a descriptive title in the format Add Name of List (Example: Add Swift), not Update readme.md or Add awesome list.
  • The entry in the Awesome list should:
    • Include a short description about the project/theme of the list. It should not describe the list itself.
      Example: - [Fish](…) - User-friendly shell., not - [Fish](…) - Resources for Fish..
    • Be added at the bottom of the appropriate category.
  • The list I'm submitting 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.
  • It's the result of hard work and the best I could possibly produce.
  • Non-generated Markdown file in a GitHub repo.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • 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.
  • Has an appropriate license.
    • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
    • WTFPL and Unlicense are not acceptable licenses.
    • If you use a license badge, it should be SVG, not PNG.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
  • 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 include a Travis badge.
    You can still use Travis for list linting, but the badge has no value in the readme.

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.

@Xyroid
Copy link

Xyroid commented Nov 30, 2018

@shyim you should updated short description of the repository, currently it's just Awesome Shopware.

@shyim
Copy link
Author

shyim commented Dec 1, 2018

@Xyroid thanks corrected 😊

@automata
Copy link
Contributor

automata commented Dec 2, 2018

Here goes my review:

  • You still have to review two other awesome open PRs
  • I've run your list through awesome-lint and created a PR with fixes. There were two dead links, so I removed them. Can you please check? Fix errors from awesome-lint run shyim/awesome-shopware#21
  • Descriptions for category like Payment Plugins could be a bit more descriptive. Like Ratepay could add more information about which version of plugin and for what version of Shopware it targets.
  • As an extra, adding https://github.com/sindresorhus/awesome-lint really helps to keep your future PR's safe for most of awesome guidelines, specially when you run it automatically through Travis CI. Please, consider take a look at it, it's pretty straightforward to get it running when you have a Travis CI account.

@automata automata mentioned this pull request Dec 2, 2018
@sindresorhus
Copy link
Owner

Closing for lack of response.

@sindresorhus
Copy link
Owner

Also:

❯ awesome-lint https://github.com/shyim/awesome-shopware
✖ Linting

  README.md:87:3
  ✖   75:85  List item description must end with proper punctuation  remark-lint:awesome/list-item
  ✖   87:3   Link to https://github.com/shyim/ShyimRollbar is dead   remark-lint:no-dead-urls
  ✖  108:3   Link to https://github.com/shyim/ShyimDisqus is dead    remark-lint:no-dead-urls
  ✖  123:88  List item description must end with proper punctuation  remark-lint:awesome/list-item
  ✖  124:81  List item description must end with proper punctuation  remark-lint:awesome/list-item

  5 errors

https://github.com/sindresorhus/awesome-lint

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.

4 participants