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 VBA #3153

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add VBA #3153

wants to merge 1 commit into from

Conversation

sancarn
Copy link

@sancarn sancarn commented Aug 15, 2024

awesome-vba

This PR is to add VBA to the list of programming languages.

In the world of code, VBA is the unicorn—often underestimated, but with the power to transform the mundane into the magical.

VBA is extremely limited in its base form, and libraries are so critical to developing large software today. VBA doesn't have a package manager which means it's often difficult to find VBA libraries. awesome-vba solves this issue by collating all the best libraries in one place. It also includes some useful learning resources for people looking to learn the langauge.

I have assessed all requirements and made sure that the awesome list complies with all relevant requirements. You can find my issue tracker here.

It is important to note that due to the nature of the VBA language, we cannot fully comply with the requirement below, which IMO only really makes sense for modern languages:

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.

Requirements for your pull request

  • 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.
  • 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.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • 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 of 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. It should not contain the name of the list.
    • - [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.
  • No blockchain-related lists.
  • 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.
  • 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 a maximum of half the width of the original image.
    • Don't include both a title saying Awesome X and a logo with Awesome X. You can put the header image in a # (Markdown header) or <h1>.
  • 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. The 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.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not 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.

@sancarn
Copy link
Author

sancarn commented Aug 15, 2024

Updated to fix some more of the awesome-lint issues which were overlooked.

It should be noted that many of the awesome-lint issues which remain are due to the inclusion of symbology in the list. I personally feel this symbology is invaluable and a requirement due to the nature of VBA/VB6. List would significantly lose usability without it.

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

@sancarn
Copy link
Author

sancarn commented Aug 15, 2024

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.

@sindresorhus Can you be more precise, as currently I'm not sure if this response is merely automated? You can check the issue tracker to see I have gone through your requirements multiple times (over 4 passes now) so if it hasn't been picked up yet, it likely won't in another pass 😅

Please also see sindresorhus/awesome-lint#199 for reasons why the linter is failing. These failures were known about before the PR was submitted.

@lloydshanks
Copy link

@sancarn The linter doesn't like the links as they are invalid. The ![p_win] and ![a_all] syntax creates clickable images that link to a section of the document. The #- part is meant to serve as an anchor link, but since #- does not refer to any actual section in the document, clicking the images would not navigate to a meaningful place within the document.

Can you link them to somewhere else in the document? Or use different emojis?

@sancarn
Copy link
Author

sancarn commented Aug 23, 2024

The linter doesn't like the links as they are invalid. The [![p_win]] syntax creates clickable images that link to a section of the document. The #- part is meant to serve as an anchor link, but since #- does not refer to any actual section in the document, clicking the images would not navigate to a meaningful place within the document.

Yeah this is our expected cause as well. Hence why we raised sindresorhus/awesome-lint#199

Can you link them to somewhere else in the document? Or use different emojis?

We did discuss this, and though we feel it would be doable, we also feel it would significantly decrease the usability of the document, (and would make the document much less awesome!)

@uyentrang3107
Copy link

🏧

@ghost
Copy link

ghost commented Sep 3, 2024 via email

@uyentrang3107
Copy link

Ok

Copy link

@uyentrang3107 uyentrang3107 left a comment

Choose a reason for hiding this comment

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

@lloydshanks lloydshanks mentioned this pull request Sep 25, 2024
33 tasks
@Axorax
Copy link

Axorax commented Oct 28, 2024

Adding icons after the items in the list would look better.

@sancarn
Copy link
Author

sancarn commented Oct 30, 2024

@Axorax interesting, i disagree from the perspective that currently icons are aligned therefore easy to parse

- 🪟⭐ Something - Something awesome
- 🍎⭐ Something else - Something else awesome
- 🪟⭐ Peanut - a delicious nut

vs

- Something - Something awesome 🪟⭐
- Something else - Something else awesome 🍎⭐
- Peanut - a delicious nut 🪟⭐

In the latte case you are having to search to the end of the sentence continually, and this may be on a new line etc. In the former case they are right at the front and all aligned together. So I personally feel this is better.

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