material-extensions / vscode-material-icon-theme

Available on the VSCode Marketplace
https://marketplace.visualstudio.com/items?itemName=PKief.material-icon-theme
MIT License
2.05k stars 629 forks source link

Added useful links to encourage users to help the project #2524

Open okineadev opened 1 month ago

okineadev commented 1 month ago

Description

It's a bit difficult to do from the phone, but it's okay

Contribution Guidelines

PKief commented 1 month ago

I also just analyzed a few other popular VS Code extensions, and they mostly have this information at the end of their readme file. E.g. https://marketplace.visualstudio.com/items?itemName=octref.vetur or https://marketplace.visualstudio.com/items?itemName=formulahendry.auto-rename-tag or https://marketplace.visualstudio.com/items?itemName=christian-kohler.path-intellisense.

So the README.md file is the entry point in representing a VS Code extension. And if the first message people see is "Request Icon" or "Contribute" it's not the most important thing to them. First of all they want to know "What is this extension about" or "What kind of value does it bring". Contributions are also important - but rather to a smaller group of users of this extension. I'd guess that for most users the icons which are already provided are sufficient als we already support nearly all of the common icons.

okineadev commented 1 month ago

I don't see the need for these links at this point, it makes the readme less attractive from my point of view. Don't you think that the contributors section at the end of the readme already describes everything potential contributors need?

https://github.com/material-extensions/vscode-material-icon-theme?tab=readme-ov-file#contributors

Maybe we can put the links below the badges if we need it, but I'm not so sure about it.

And indeed. Then you can put the link "request an icon" under the image with icons, this will not spoil the README, but you will also be able to quickly find this link to request an icon

For example, the user looks at the icons and does not see the icon he would like to see, scrolls down and sees the "Request icon" link

okineadev commented 1 month ago

@coderabbitai What do you think would be the most neutral and reasonable solution for placing links?

coderabbitai[bot] commented 1 month ago

[!TIP] For best results, initiate chat on the files or code changes.

@okineadev: A neutral and reasonable solution would be to place the "Request Icon" link directly under the section displaying the icons. This way, users who are specifically interested in icons can easily find the link if they need to request one. For other contribution-related links, placing them below the badges at the top of the README could be a good compromise. This ensures they are visible to those interested in contributing without detracting from the main purpose of the README, which is to explain the extension's value and functionality.

This approach balances the needs of both users and potential contributors by making the links accessible without overwhelming the primary content of the README.