🔀 Merge pull request #358 from walkxcode/new-standards

Co-authored-by: Template to Readme <noreply@walkx.org>
Co-authored-by: Nic Luckie <nicolas_luckie@hotmail.com>
Co-authored-by: Dashboard Icons Bot <noreply@walkx.fyi>
Co-authored-by: Aabishkar KC <aabishkar@gmail.com>
Co-authored-by: Evan <esteinkerchner@gmail.com>
Co-authored-by: zry98 <dev@zry.io>
Co-authored-by: AJ Slater <aj@slater.net>
Co-authored-by: cfouche3005 <51720655+cfouche3005@users.noreply.github.com>

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: [https://shop.walkx.fyi/l/donate]

.github/ISSUE_TEMPLATE/_request_suggest.yml

@@ -1,36 +1,26 @@
-name: ⚡️ Requests & Suggestions
+name: "\U0001FA79 Requests & Suggestions"
 description: Suggest an icon or request changes
-title: "⚡ — *put a quick title describing your issue here*"
+labels: "\U0001FA79 Requests & Suggestions"
-labels: ⚡️ Requests & Suggestions
+assignees: walkxcode
-assignees: WalkxCode
 body:
   - type: markdown
     attributes:
-      value: |
+      value: "Thank you for your interest in contributing to our icon repository! To ensure that everything runs smoothly, we've set out some guidelines for contributors.\n## \U0001F31F Icon Specifications\n\n- Each icon should be in `PNG` format and have a height of exactly `512px`. Width does not matter. ❗️(No upscales! If the correct size cannot be found, a smaller height will be accepted.)\n\n- Each icon should include both a `PNG` and `SVG` version. If an `SVG` cannot be found, then only a `PNG` version is required.\n\n- Icons should be named after their full name, with spaces replaced by dashes. For example, \"Facebook Messenger\" should be named `facebook-messenger.png`.\n\n- Monochrome icons should default to a dark version. Light versions should be named `service-light.png`. If a light version is not available, use https://pinetools.com/colorize-image to change its color.\n\n- If an `SVG` is available for an icon, the `PNG` should be a conversion of that `SVG`. Use https://ezgif.com/svg-to-png to do this. Set the height to `512px` and leave the width empty.\n"
-        *Thank you in advance for taking the time to fill out this Requests & Suggestions form!*
-  - type: dropdown
-    id: type
-    attributes:
-      label: Type
-      description: Choose the option below which best descibes your issue.
-      options:
-        - Icon request
-        - Icon enhancement
-        - Documentation change
   - type: textarea
-    id: info
+    id: icon-name
     attributes:
-      label: Info
+      label: Icon Name
-      description: Place any relevant information here. Information about the icons you want to request, the documentation changes you want to see, etc.
+      description: What is the name of the icon you are contributing?
-      placeholder: ex. Please add a dark version for the Homarr icon.
+      placeholder: Enter icon name here
     validations:
       required: true
   - type: textarea
-    id: icon
+    id: icons
     attributes:
       label: Icon(s)
-      description: Upload your icons here. You can do this by Copy-Pasting or Drag&Dropping the images.
+      description: >-
-      placeholder: SVG and PNG accepted!
+        Upload your icons here. You can do this by Copy-Pasting or Drag &
+        Dropping the images.
+      placeholder: Copy-Paste or Drag & Drop images here!
     validations:
       required: false
-  

.github/workflows/_readme_generator.yml

@@ -1,4 +1,4 @@
-name: 👉 Template to Readme
+name: 🚀 Generates README
 
 on:
   push:
@@ -17,7 +17,7 @@ jobs:
           python-version: "3.9"
           architecture: "x64"
 
-    - name: Template to Readme
+    - name: Readme Generator
       run: |-
         python _ci.py
         cat README.md
@@ -25,8 +25,8 @@ jobs:
     - name: Load to GitHub
       run: |-
         git diff
-        git config --global user.email "noreply@walkx.org"
+        git config --global user.email "noreply@walkx.fyi"
-        git config --global user.name "Template to Readme"
+        git config --global user.name "Dashboard Icons Bot"
         git add -A
-        git commit -m "👉 Converts _template to readme" || exit 0
+        git commit -m "🚀 Generates README" || exit 0
         git push

CODE_OF_CONDUCT.md

@@ -0,0 +1,23 @@
+# 🚨 Code of Conduct
+
+We are committed to providing a welcoming and harassment-free environment for everyone who wants to participate in our icon repository, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, religion, or nationality.
+
+## 💬 Communication
+
+All communication should be appropriate for a professional audience including people of many different backgrounds. Be respectful, considerate, and constructive in all communication, both online and offline.
+
+## 🚫 Prohibited Behavior
+
+Harassment, intimidation, discrimination, or any other inappropriate conduct or behavior will not be tolerated. This includes, but is not limited to, the use of sexual language or imagery, deliberate intimidation, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, and unwelcome sexual attention.
+
+## 📢 Reporting
+
+If you believe someone is violating the code of conduct, please report it immediately to contact@walkx.fyi. All reports will be reviewed and investigated promptly and confidentially.
+
+## 🚨 Consequences
+
+Anyone found to be engaging in behavior that violates the code of conduct will be subject to appropriate action, which may include, but is not limited to, warning, removal from the repository, or banning from participation in the repository.
+
+## 👍 Acknowledgment
+
+We ask that all participants in this repository agree to abide by this code of conduct. By contributing to this repository, you agree to these terms and conditions. Thank you for helping us create a welcoming and inclusive environment for all. 🙏

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# 🎉 Contributing Guidelines
+
+Thank you for your interest in contributing to our icon repository! To ensure that everything runs smoothly, we've set out some guidelines for contributors.
+
+## 🌟 Icon Specifications
+
+- Each icon should include both a **PNG** and **SVG** version. If an **SVG** cannot be found, then only a **PNG** version is required.
+- Each icon should be in **PNG** format and have a height of exactly **512px**. Width does not matter. ❗️(No upscales! If the correct size cannot be found, a smaller height will be accepted.)
+- Icons should be named after their full name, using the [Kebab Case](https://wiki.c2.com/?KebabCase) naming convention. For example, "Facebook Messenger" should be named `facebook-messenger.png`.
+- Monochrome icons should default to a dark version. Light versions should be named `service-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to change its color.
+
+
+## 💻 Gitmoji Commits
+
+- Please use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For example, you might use the `🍱` emoji for a commit that updates an icon's color, or the `📝` emoji for a commit that updates the documentation.
+
+
+## 🤝 Contributing
+
+1. Fork the repository to your own GitHub account.
+2. Clone the repository to your local machine.
+3. Add your icon(s) to the repository, following the specifications listed above.
+4. Push your changes to your fork.
+5. Create a pull request in the main repository.
+
+## 🚨 Code of Conduct
+
+Please note that by contributing to this repository, you agree to abide by our code of conduct, which can be found in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file in the repository.
+
+---
+
+If you have any questions or concerns, please don't hesitate to reach out to me at contact@walkx.fyi. Happy contributing! 🙌

_TEMPLATE.md

@@ -1,37 +1,33 @@
 <p align="center">
-  <h3 align = "center" > 🟣 Dashboard Icons </h3>
+  <h2 align="center"> 🟣 Dashboard Icons </h3>
   <p align="center">
     <a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
-      <img src="https://data.jsdelivr.com/v1/package/gh/walkxcode/dashboard-icons/badge/week?style=rounded"/>
+      <img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
     </a>
   </p>
-
   <p align="center">
-    ❤️ The best icons for your personal dashboard.
+    🚀 The best place to find icons for your dashboards.
- <br/>
+    <br />
-    <a href="#icons"> <strong > See the icons »</strong> </a>
+    <a href="#-icons"><strong>👀 See the icons</strong></a> • <a href="https://shop.walkx.fyi/l/donate" target="_blank"><strong>🙌🏻 Donate</strong></a>
- <br/>
+    <br />
- <br/>
+    <br />
+  </p>
 </p>
 
-# Table of Contents
+# 📖 Table of Contents
 
-- [Table of Contents](#table-of-contents)
+- [🚀 Getting Started](#-getting-started)
-- [Getting Started](#getting-started)
+  - [📊 Dashboards](#-dashboards)
-  - [Dashboards](#dashboards)
+  - [🛠️ Installation](#️-installation)
-  - [Installation](#installation)
+- [🎨 Icons](#-icons)
-- [Icons](#icons)
+- [🎉 Contributing Guidelines](#-contributing-guidelines)
-- [Legal](#legal)
+- [📜 Legal](#-legal)
 
-<!-- GETTING STARTED -->
+## 🚀 Getting Started
 
-# Getting Started
+### 📊 Dashboards
 
-## Dashboards
+There are many Dashboards available that you can use with Dashboard Icons. Here are some of the popular ones.
-
-There's multiple Dashboards available. Here are some of the popular ones.
-<br />
-_Dashboards with a \* have native integration with Dashboard Icons._
 
 - [Homarr](https://github.com/ajnart/homarr)\*
 - [Dashy](https://github.com/Lissy93/dashy)\*
@@ -42,13 +38,15 @@ _Dashboards with a \* have native integration with Dashboard Icons._
 - [SUI](https://github.com/jeroenpardon/sui)
 - [Homepage](https://github.com/benphelps/homepage)\*
 
-## Installation
+**Note:** Dashboards with a \* have native integration with Dashboard Icons.
 
-**TIP! You can access Dashboard Icons online, faster, by using `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`**
+### 🛠️ Installation
 
-To download an icon, simple `Right click > Save image`.
+**Tip!** You can access Dashboard Icons online, faster, by using `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`. Just replace `example` with the name of the icon!
 
-For non-desktop operating systems, or people that prefer to use terminal.
+To download an icon, simply `Right click > Save image`.
+
+For non-desktop operating systems or people who prefer to use the terminal:
 
 ```sh
 $ curl https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png > example.png
@@ -57,19 +55,21 @@ $ curl https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/ex
 or
 
 ```sh
-$ wget https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png - O example.png
+$ wget https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png -O example.png
 ```
 
-# Icons
+## 🎨 Icons
-
+<details>
+  <summary>Click to display all icons 👀</summary>
 <!-- ICONS -->
-
 <!-- END ICONS -->
+</details>
 
-<!-- LEGAL -->
+## 🎉 Contributing Guidelines
+Please read the [Contributing Guidelines](CONTRIBUTING.md) before contributing to this project.
 
-# Legal
+## 📜 Legal
 
-(Almost) All product names, trademarks and registered trademarks in the images in this repository, are property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.
+(Almost) All product names, trademarks, and registered trademarks in the images in this repository are the property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.
 
-The use of these names, trademarks and brands appearing in these image files, do not imply endorsement.
+The use of these names, trademarks, and brands appearing in these image files does not imply endorsement.

_ci.py

@@ -7,7 +7,7 @@ readme_path = root / "README.md"
 
 
 def generate_img_tag(file):
-    return f'<img src="https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/{file.name}" alt="{file.stem}" width="50">'
+    return f'<img src="png/{file.name}" alt="{file.stem}" height="50">'
 
 
 imgs = sorted(Path("./png").glob("*.png"))