devicons / devicons/devicon

[FEATURE REQUEST] Devicon Prep-script before contributor open a PR into the repo

Offen
#987 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
devops discussion enhancement
Vorherrschende Sprache
CSS
Sterne
11.8k
Forks
2.4k
Ø Merge
5 T. 9 Std.
Gemergte PRs (30 T.)
4

Beschreibung

### Problem

The `check-svg` and `peek-bot` works by checking the SVG and reporting their status to us. While this works great, the contributor would need some time to work on the changes. We then need some time to check the repo again and check the PRs. While it works well, I think time could be reduced even more.

Another issue is making the `devicon.js` entry. Some fields are confusing (like `aliases`) or has no standard (what do we even use `tag` for?). It would be nice to make it easier for people to create the `devicon.json` entry.

### Suggested feature

Create a script that the contributors run locally before they open a PR. This workflow would look like:
- User create the SVG files
- User run the script
- The script would:
- Ask for the SVG folder name
- Check the SVGs are up to standards
- Auto-detect plain versions. If none exist, ask the user which version are plain-friendly.
- Assist with making `aliases` entry
- Ask user which tags they want. Here, we can specify the tags -> standardize our tag system.
- Print out the `devicon.json` entry (or even write to the `json` file directly -> keep it sorted)
- If any error exist, the user can fix them right away.
- Repeat until no error
- Push and open a PR

Thus, the script would make standard checking much faster since they don't have to wait for us. Furthermore, we ensure that the json entry is proper.

Some disadvantages:
- Standardizing the tag system would be unnecessary if we don't even use the tags.
- Which language do we use to make this script? While NodeJS seems common (we do have a `package.json`), it is possible that the contributor is an artist or graphic designer who doesn't have the NodeJS parser.
- The `check-svg` works well as it is right now. Most PRs are merged within a few days which is fine. Do we really need this feature?

My biggest thing is making it easier to make the `devicon.json` entry. The faster standard-checking thing is more like an added bonus. I also think of adding an extra html page to our current site and assist the user that way.

### Why should we have this feature?

_No response_

### Additional information

_No response_

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die vorhandenen check-svg- und peek-bot-Workflows zu lesen, und sieh dir dann package.json, devicon.js und devicon.json an, um die aktuelle Validierung und die Formate der Einträge zu verstehen. Lege vor der Implementierung die Laufzeit und den Umfang des Skripts fest; abgeschlossen wäre die Aufgabe, wenn Mitwirkende SVGs lokal validieren und einen standardisierten devicon.json-Eintrag erstellen können, ohne auf eine PR-Prüfung warten zu müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
nodejs
Bereich
developer-experience, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.