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 V #1684

Merged
merged 7 commits into from
Apr 27, 2020
Merged

Add V #1684

merged 7 commits into from
Apr 27, 2020

Conversation

Delta456
Copy link
Contributor

@Delta456 Delta456 commented Jan 12, 2020

V is a new programming language inspired from C, C++, Go and Python.

This list is very useful for those who want to know more about the language.

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

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.
  • 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
    • 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.
  • 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.
  • 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=master&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 or text to the readme. GitHub already shows the license name 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.
  • 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.
  • 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.

@Delta456 Delta456 changed the title Add awesome_v Add V Jan 12, 2020
@aliesbelik
Copy link
Contributor

aliesbelik commented Jan 12, 2020

You've created a substantial collection of resources, but you appear to be missing a bunch of items from the requirements list.

Let's complete the quest:

  • add 2 PRs you reviewed;
  • add awesome-list and awesome as GitHub topics (as well as any other relevant, if any);
  • Awesome badge should be placed on the right side of the readme heading;
  • ToC section should be named Contents, not Table of Contents;
  • add license;
  • add contribution guidelines;
  • add project logo;
  • finally check guidelines if something still missing.

Copy link
Contributor

@aliesbelik aliesbelik left a comment

Choose a reason for hiding this comment

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

Update link to point out at the readme file, to make uniform with all the other across the list:
https://github.com/vlang/awesome-v#readme

@aliesbelik
Copy link
Contributor

Please check list items formatting:

  • use dash - instead of asterisk * for the entries;
  • ensure that list item description start with valid casing;
  • use dash as separator between link and description.

Using awesome-lint may help you a lot.

@alexesprit
Copy link

@aliesbelik Hi! Thanks for reviewing awesome-v!

use dash - instead of asterisk * for the entries;

Interesting that running awesome-lint README.md does not show errors if we use asterisks only.

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@aliesbelik
Copy link
Contributor

Interesting that running awesome-lint README.md does not show errors if we use asterisks only.

@alexesprit sorry, that's my fault: because of incorrect ToC header anchors in list entries were treated as incorrect URLs (Invalid list item link URL). Will be validated with using of Contents header instead.

@alexesprit
Copy link

Now vlang/awesome-v passes awesome-lint.

@aliesbelik What do you think? Have we some missing things should be fixed?

@aliesbelik
Copy link
Contributor

Looks fine to me.

But to complete the quest please add at least 2 PRs you reviewed for this project.
Dura lex, sed lex.

@alexesprit
Copy link

I'm not an author of this PR, but I want to get this one merged. Also, I contributed to awesome-v to make it possible to pass awesome-lint.

PRs I reviewed: #1675, #1679.

@alexesprit
Copy link

unicorn

@Delta456
Copy link
Contributor Author

Reviewed #1683 #1682

@aliesbelik
Copy link
Contributor

@alexesprit, I appreciate your efforts.

Looking into the other PRs I can note that adding link to V's website for V in V is a simple, fast, safe, compiled language for developing maintainable software. is nice to have.

All the other points look good to me.

@alexesprit
Copy link

@aliesbelik Good catch! I added the link to the V website.

Copy link

@liamka liamka left a comment

Choose a reason for hiding this comment

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

Great!

@jetli
Copy link
Contributor

jetli commented Jan 22, 2020

Please use the default PR template of awesome project for your PR description, you can refer to #1688, see the description of this PR.

@jetli jetli mentioned this pull request Jan 22, 2020
@Delta456
Copy link
Contributor Author

Delta456 commented Feb 7, 2020

@jetli done

@FatemehTarashi
Copy link

Looks good. 👍

@aliesbelik
Copy link
Contributor

Seems like this PR can be finally merged.

@bernardoduarte
Copy link

Couldn't find anything wrong. Great awesome list!

@medvednikov
Copy link

Can you merge it please?

@alexesprit
Copy link

This PR should be rebased on to latest master to satisfy the guidelines:

Your entry should be added at the bottom of the appropriate category.

Also, it breaks the Coq description - removes dot at the end of the description.

The first character should be uppercase and the description should end in a dot.

@Delta456
Copy link
Contributor Author

Delta456 commented Mar 25, 2020

@medvednikov and @alexesprit done

@alexesprit
Copy link

It's still not at the bottom of the list.

@Delta456
Copy link
Contributor Author

@alexesprit now done?

@medvednikov
Copy link

Can you merge please?

@Delta456
Copy link
Contributor Author

Can anyone please merge this?

@medvednikov
Copy link

Any plans to merge?

@sindresorhus sindresorhus merged commit 15370ab into sindresorhus:master Apr 27, 2020
@sindresorhus
Copy link
Owner

DejanPerovic pushed a commit to DejanPerovic/awesome that referenced this pull request Jul 6, 2020
@aliesbelik aliesbelik mentioned this pull request Oct 14, 2021
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