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 Memgraph #2287

Closed
wants to merge 3 commits into from
Closed

Add Memgraph #2287

wants to merge 3 commits into from

Conversation

kgolubic
Copy link

(https://github.com/kgolubic/awesome-memgraph)

Memgraph is an in-memory graph database. I'm curating Memgraph Awesome list and I believe that it is a good add-on to this list.

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

I've reviewed following PRs:

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

Memgraph is an in-memory graph database. I'm curating Memgraph Awesome list and I believe that it is a good add-on to this list.
@kgolubic
Copy link
Author

HI! I've fixed all of the errors reported by lint. I think that the remaining errors are false positives. I do have some links listed twice, but they appear in a different context. If this is not ok I can remove the duplicate links.

@villesundell
Copy link
Contributor

@kgolubic We have the same situation, and we opted to lint disable double-link as seen here: https://raw.githubusercontent.com/MystenLabs/awesome-move/446c2b511720c1c8f01af5d7f02861f3635121e7/README.md (the first line). Linting is part of Awesome's PR process, so in my understanding it must pass. (Awesome-move is not part of the "awesomeverse" yet.)

@kgolubic
Copy link
Author

unicorn

@kgolubic
Copy link
Author

@kgolubic We have the same situation, and we opted to lint disable double-link as seen here: https://raw.githubusercontent.com/MystenLabs/awesome-move/446c2b511720c1c8f01af5d7f02861f3635121e7/README.md (the first line). Linting is part of Awesome's PR process, so in my understanding it must pass. (Awesome-move is not part of the "awesomeverse" yet.)

Thanks for the pointers. I've managed to fix all errors and npx awesome-lint https://github.com/kgolubic/awesome-memgraph gives me a passing mark.

What should I do now? Can I somehow re-run the check here on GitHub?

@kgolubic
Copy link
Author

@sindresorhus can you please tell me what should I do now? Can I somehow re-run the check here on GitHub? Local lint tells me that everything is ok now. Should I close this PR and open a new one?

@villesundell villesundell mentioned this pull request Jun 28, 2022
@0Lola
Copy link
Contributor

0Lola commented Aug 22, 2022

Hi @kgolubic,

Here are some of the points I think you can improve on readme:

  • Remove Inspired by the awesome list thing. Feel free to improve this list by contributing!

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.

  • Remove unknown wording ==============.

  • Add Memgraph Logo on the top-right like this.

Includes a project logo/illustration whenever possible.

The link and description are separated by a dash.
Example: - AVA - JavaScript test runner.

Hope that helps.

@kgolubic
Copy link
Author

kgolubic commented Nov 2, 2022

All checks have passed ok.

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

There are many things not followed in the guidelines.

You have also not addressed the feedback in #2287 (comment).


Includes a succinct description of the project/theme at the top of the readme.

@kgolubic
Copy link
Author

Hi @kgolubic,

Here are some of the points I think you can improve on readme:

  • Remove Inspired by the awesome list thing. Feel free to improve this list by contributing!

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.

  • Remove unknown wording ==============.
  • Add Memgraph Logo on the top-right like this.

Includes a project logo/illustration whenever possible.

The link and description are separated by a dash.
Example: - AVA - JavaScript test runner.

Hope that helps.

I've updated the README.md file in accordance with your comments. Thank you!

@kgolubic
Copy link
Author

kgolubic commented Nov 20, 2022

There are many things not followed in the guidelines.

You have also not addressed the feedback in #2287 (comment).

Includes a succinct description of the project/theme at the top of the readme.

@sindresorhus Thank you for pointing this out. I've fixed all of the mentioned issues, added the logo and description on the top, shortened the description for the main Aweosnm list, and separated descriptions of links with "-". I hope that I've covered all of the issues.

@kgolubic kgolubic requested review from Lissy93 and sindresorhus and removed request for Lissy93 and sindresorhus January 23, 2023 07:26
@sindresorhus
Copy link
Owner

The image should be high-DPI. Set it to maximum half the width of the original image.


Missing descriptions: https://github.com/kgolubic/awesome-memgraph#tools


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


"How Node2Vec Works - A Random Walk-Based Node Embedding Method"

Descriptions should not be title-cased.

@kgolubic
Copy link
Author

Thank you @sindresorhus and @Lissy93. I've updated my list according to your comments.

@grem11n
Copy link

grem11n commented Mar 8, 2023

@kgolubic, according to this awesome-lint rule descriptions in a list should end with a punctuation mark such as dot. There are a couple of occasions where your list is missing it. For example:

### Tools

- [Memgraph Lab](https://memgraph.com/lab) - a visual user interface that helps you explore and manipulate the data stored in Memgraph

Other descriptions have this problem as well.

@sindresorhus
Copy link
Owner

Bump

@kgolubic
Copy link
Author

Bump

Sorry for the late answer. I missed the previous comment. I've updated descriptions with dots where they were needed.

@sindresorhus
Copy link
Owner

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

@sindresorhus
Copy link
Owner

I'm going to pass on this as it's taking too long and there are still many things not followed and I think the list in general could be improved.

@kgolubic
Copy link
Author

kgolubic commented Jun 20, 2023

Ok. Thanks for all of the feedback. When I find the time, I'll improve the list and submit it again for consideration.

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.

6 participants