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 Nim #2442

Closed
wants to merge 1 commit into from
Closed

Add Nim #2442

wants to merge 1 commit into from

Conversation

tomByrer
Copy link

cheers

https://github.com/ringabout/awesome-nim#readme

statically typed compiled systems programming language; 14k stars; been around for a few years

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

14k stars; been around for a few years

cheers
@hallvaaw
Copy link
Contributor

Hi @tomByrer,

A couple of things need to be fixed:

  • The repository needs a heading title in title case format i.e. "Awesome Nim".
  • The information about the logo at the bottom of the readme should be included in a Footnotes section.
  • You need to review 2 other open pull requests. If you already have done so, can you specify which?

ArikRahman added a commit to ArikRahman/awesome-nim that referenced this pull request Nov 30, 2022
ringabout pushed a commit to ringabout/awesome-nim that referenced this pull request Nov 30, 2022
* Added footnotes

For compliance with sindresorhus/awesome#2442 (comment)

* Put moe in the correct place
@satta
Copy link
Contributor

satta commented Dec 14, 2022

In addition to the remark about the missing text-based headline, there are still some items that are not properly formatted, for example they are lacking the terminating period or casing. E.g. lines 306, 450, 642, 683, 741 and 790 of the current main.

The ToC has up to three levels of nesting, while the requirements suggest to use one.

The text Option[T] on line 152 is interpreted as a Markdown reference, which is probably isn't. I guess you could mark it as code to address that.

@satta satta mentioned this pull request Dec 14, 2022
@modenero
Copy link

modenero commented Feb 7, 2023

The linter returned 103 errors

npx awesome-lint https://github.com/ringabout/awesome-nim

resulted in:

✖ Linting

  README.md:152:124
  ✖    1:1    Missing main list heading                               remark-lint:awesome-heading
  ✖    1:1    Missing or invalid Table of Contents                    remark-lint:awesome-toc
  ✖    9:3    Invalid list item link URL                              remark-lint:awesome-list-item
[...]
  ✖  128:40   Text "Javascript" should be written as "JavaScript"     remark-lint:awesome-spell-check
  ✖  152:124  Found reference to undefined definition                 remark-lint:no-undefined-references
  ✖  317:53   List item description must end with proper punctuation  remark-lint:awesome-list-item
[...]

103 errors

you can find the full ESLint documentation here

@modenero modenero mentioned this pull request Feb 7, 2023
@zakarialaoui10
Copy link

zakarialaoui10 commented Feb 13, 2023

The Linter returns 103 errors

✖ 1:1 Missing main list heading remark-lint:awesome-heading
✖ 1:1 Missing or invalid Table of Contents remark-lint:awesome-toc
✖ 9:3 Invalid list item link URL remark-lint:awesome-list-item
✖ 10:5 Invalid list item link URL remark-lint:awesome-list-item
✖ 11:5 Invalid list item link URL remark-lint:awesome-list-item
✖ 12:5 Invalid list item link URL remark-lint:awesome-list-item
✖ 13:5 Invalid list item link URL remark-lint:awesome-list-item
✖ 14:5 Invalid list item link URL remark-lint:awesome-list-item
15:5 Invalid list item link URL remark-lint:awesome-list-item
16:5 Invalid list item link URL remark-lint:awesome-list-item
17:5 Invalid list item link URL remark-lint:awesome-list-item
18:5 Invalid list item link URL remark-lint:awesome-list-item
19:5 Invalid list item link URL remark-lint:awesome-list-item
20:5 Invalid list item link URL remark-lint:awesome-list-item
21:5 Invalid list item link URL remark-lint:awesome-list-item
22:5 Invalid list item link URL remark-lint:awesome-list-item
23:3 Invalid list item link URL remark-lint:awesome-list-item
24:5 Invalid list item link URL remark-lint:awesome-list-item
25:5 Invalid list item link URL remark-lint:awesome-list-item
26:5 Invalid list item link URL remark-lint:awesome-list-item
27:5 Invalid list item link URL remark-lint:awesome-list-item
28:5 Invalid list item link URL remark-lint:awesome-list-item
29:5 Invalid list item link URL remark-lint:awesome-list-item
30:3 Invalid list item link URL remark-lint:awesome-list-item
31:5 Invalid list item link URL remark-lint:awesome-list-item
32:3 Invalid list item link URL remark-lint:awesome-list-item
33:3 Invalid list item link URL remark-lint:awesome-list-item
34:5 Invalid list item link URL remark-lint:awesome-list-item
35:7 Invalid list item link URL remark-lint:awesome-list-item
36:7 Invalid list item link URL remark-lint:awesome-list-item
37:5 Invalid list item link URL remark-lint:awesome-list-item
38:5 Invalid list item link URL remark-lint:awesome-list-item
39:5 Invalid list item link URL remark-lint:awesome-list-item
40:5 Invalid list item link URL remark-lint:awesome-list-item
41:3 Invalid list item link URL remark-lint:awesome-list-item
42:5 Invalid list item link URL remark-lint:awesome-list-item
43:5 Invalid list item link URL remark-lint:awesome-list-item
44:5 Invalid list item link URL remark-lint:awesome-list-item
45:3 Invalid list item link URL remark-lint:awesome-list-item
46:5 Invalid list item link URL remark-lint:awesome-list-item
47:5 Invalid list item link URL remark-lint:awesome-list-item
48:5 Invalid list item link URL remark-lint:awesome-list-item
49:3 Invalid list item link URL remark-lint:awesome-list-item
50:5 Invalid list item link URL remark-lint:awesome-list-item
51:7 Invalid list item link URL remark-lint:awesome-list-item
52:7 Invalid list item link URL remark-lint:awesome-list-item
53:7 Invalid list item link URL remark-lint:awesome-list-item
54:7 Invalid list item link URL remark-lint:awesome-list-item
55:5 Invalid list item link URL remark-lint:awesome-list-item
56:5 Invalid list item link URL remark-lint:awesome-list-item
57:5 Invalid list item link URL remark-lint:awesome-list-item
58:5 Invalid list item link URL remark-lint:awesome-list-item
59:5 Invalid list item link URL remark-lint:awesome-list-item
60:3 Invalid list item link URL remark-lint:awesome-list-item
61:5 Invalid list item link URL remark-lint:awesome-list-item
62:5 Invalid list item link URL remark-lint:awesome-list-item
63:5 Invalid list item link URL remark-lint:awesome-list-item
64:7 Invalid list item link URL remark-lint:awesome-list-item
65:7 Invalid list item link URL remark-lint:awesome-list-item
66:7 Invalid list item link URL remark-lint:awesome-list-item
67:7 Invalid list item link URL remark-lint:awesome-list-item
68:7 Invalid list item link URL remark-lint:awesome-list-item
69:5 Invalid list item link URL remark-lint:awesome-list-item
70:3 Invalid list item link URL remark-lint:awesome-list-item
71:5 Invalid list item link URL remark-lint:awesome-list-item
72:7 Invalid list item link URL remark-lint:awesome-list-item
73:7 Invalid list item link URL remark-lint:awesome-list-item
74:7 Invalid list item link URL remark-lint:awesome-list-item
75:7 Invalid list item link URL remark-lint:awesome-list-item
76:5 Invalid list item link URL remark-lint:awesome-list-item
77:5 Invalid list item link URL remark-lint:awesome-list-item
78:5 Invalid list item link URL remark-lint:awesome-list-item
79:5 Invalid list item link URL remark-lint:awesome-list-item
80:5 Invalid list item link URL remark-lint:awesome-list-item
81:3 Invalid list item link URL remark-lint:awesome-list-item
82:5 Invalid list item link URL remark-lint:awesome-list-item
83:5 Invalid list item link URL remark-lint:awesome-list-item
84:5 Invalid list item link URL remark-lint:awesome-list-item
85:5 Invalid list item link URL remark-lint:awesome-list-item
86:3 Invalid list item link URL remark-lint:awesome-list-item
87:5 Invalid list item link URL remark-lint:awesome-list-item
88:5 Invalid list item link URL remark-lint:awesome-list-item
89:5 Invalid list item link URL remark-lint:awesome-list-item
90:5 Invalid list item link URL remark-lint:awesome-list-item
91:5 Invalid list item link URL remark-lint:awesome-list-item
92:5 Invalid list item link URL remark-lint:awesome-list-item
93:5 Invalid list item link URL remark-lint:awesome-list-item
94:5 Invalid list item link URL remark-lint:awesome-list-item
95:5 Invalid list item link URL remark-lint:awesome-list-item
96:3 Invalid list item link URL remark-lint:awesome-list-item
97:5 Invalid list item link URL remark-lint:awesome-list-item
98:5 Invalid list item link URL remark-lint:awesome-list-item
99:5 Invalid list item link URL remark-lint:awesome-list-item
100:5 Invalid list item link URL remark-lint:awesome-list-item
101:5 Invalid list item link URL remark-lint:awesome-list-item
✖ 128:40 Text "Javascript" should be written as "JavaScript" remark-lint:awesome-spell-check
✖ 152:124 Found reference to undefined definition remark-lint:no-undefined-references
✖ 317:53 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 450:60 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 643:49 List item description must start with valid casing remark-lint:awesome-list-item
✖ 684:49 List item description must start with valid casing remark-lint:awesome-list-item
✖ 742:58 List item description must end with proper punctuation remark-lint:awesome-list-item
✖ 791:57 List item description must end with proper punctuation remark-lint:awesome-list-item

103 errors

@zakarialaoui10 zakarialaoui10 mentioned this pull request Feb 13, 2023
@sindresorhus
Copy link
Owner

Bump

@relatedcode
Copy link

Hi,
Thanks for making this awesome list.
As far as I can see, this list do not meet all of the requirements for an awesome list.
"The first character should be uppercase and the description should end in a dot.".

naylib - safe Raylib wrapper. in https://github.com/ringabout/awesome-nim#game-engines do not meet this requirement.

Thanks!

This was referenced May 9, 2023
@hallvaaw hallvaaw mentioned this pull request May 11, 2023
32 tasks
@sindresorhus
Copy link
Owner

Closing for lack of activity.

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