Repository-Standards durchhalten

[alxndr-w]

Vorschlag für zusätzliche gemeinsame Standards

1. Repository-Details

1. Kurzbeschreibung hinzufügen
2. Topics hinzufügen, z.B. redaxo, redaxo-addon, redaxo5, redaxo-yform
3. Packages und Deployments abwählen

Beispiel:

2. Repository-Einstellungen

Unter <https://github.com/FriendsOfREDAXO//settings`

1. Name des Add-ons = Name des Repositories
2. Default-Branch: main
3. (optional) Social Preview: AI-generiertes Bild mit dem Prompt A friendly blue T-Rex, low-poly, ...
4. Wiki abwählen
5. Projects abwählen
6. Automatically delete head branches Loading auswählen
7. Opt. Repository-Ruleset importieren

3. Basics

1. README.md hinzugefügt, Vorlage noch zu erstellen, z.B. an Blaupause orientieren
2. MIT-Lizenz-Datei erstellt
3. package.yml an FOR anpassen

4. Actions

1. Installer-Action verwenden
2. (opt) PHP-CS-Fixer Action einfügen

5. Code

1. (opt) namespace FriendsOfREDAXO\<package> als Namespace
2. (opt) in package.yml unter default_config die möglichen Konfigurationswerte der Einstellungsseiten eintragen.

6. Security

https://github.com/FriendsOfREDAXO/[package]/security

Beispiel von redaxo\redaxo

# Security Policy

## Reporting a Vulnerability

If you discover a security issue with REDAXO or a related package, please contact us
via `info {at} redaxo.org` instead of using a public channel. That way we can work on
a fix together before everyone knows how to exploit a potential issue. Thank you!

[christophboecker]

Assigned zu werden ist ja schön und gut, aber warum und wofür, was ist der Auftrag? Sollen die drei benannten nun alle Repos durchflöhen und umbauen?

Abgesehen davon ein paar Kommentare zu Deiner Liste (deren Sinn und Zweck ich keineswegs in Abrede stelle; sowas muss man einfach mal festlegen.)

Namespace sollte mindestens für neue Repos Pflicht sein. M.E. sollte spätestens bei nächsten Major Release ein Addon umgestellt werden.

Default-Branch: main => ist das nicht eh der GitHub-Standard? Bei bestehenden umzustellen bringt Verdruss (zumindest meine Erfahrung als Git-Laie)

(optional) Social Preview: AI-generiertes Bild mit dem Prompt A friendly blue T-Rex, low-poly, ... => wer sich nen AI-Abbo gönnt kann das vermutlich machen. Ich rate mal: dafür braucht es ein weitgehend vordefiniertes AI-Prompt.

Wiki abwählen => warum?

Opt. Repository-Ruleset importieren => was auch immer das ein mag ... mir sagt das jedenfalls nichts

README.md hinzugefügt, Vorlage noch zu erstellen, z.B. an Blaupause orientieren => finde ich zu eingrenzend. Readme als Pflicht, ja aber nach vorgegebenem Schema .... was ja auch erstmal jemand schreiben muss. Blaupause passt nicht zwangsläufig für alles.

package.yml an FOR anpassen => bedeutet was?

Und die wichtigste Frage: Wie will man die Einhaltung der Regeln sicherstellen. Wenn man das nicht kann ist alles optional.

[alxndr-w]

@christophboecker genau dafür habe ich dich verlinkt, um deinen Senf dazugeben zu können. :)

main-Branch: Bei bestehenden ändern hat bei mir in den letzten 2 Jahren nie zu Problemen geführt. Ich meine aber, am Anfang war das evtl. anders.

Ruleset: Erstellt habe ich z.B. für FOR-Addons, in denen ich stärker die Kontrolle behalten möchte, dieses Ruleset for-enforce-pr-in-main.json. Dadurch erwartet GitHub dann bei Änderungen einen PR und macht den Button rot mit einer Warnung, wenn man als Repo-Admin-Entwickler doch direkt committen möchte. Für mich vor allem auch zur eigenen Disziplinierung.

README.md: Es sollten zumindest die Grundfunktionen beschrieben sein, Lizenz, Lead, beteiligte Autoren und Co. angegeben werden.

Wiki: Nicht noch eine Stelle, an der Informationen liegen. Dann lieber dem Add-on beiliegend README (+ Docs).

package.yml: Autor FriendsOfREDAXO oder Friends Of REDAXO - wie auch immer die richtige Schreibweise nun lautet.

Und die wichtigste Frage: Wie will man die Einhaltung der Regeln sicherstellen. Wenn man das nicht kann ist alles optional.

Na zumindest durch Konvention und Selbstverpflichtung wird es leichter, Korrekturen vorzunehmen. Wenn keiner weiß, wie es sein sollte, macht jeder, wie er will.

[alxndr-w]

Ich habe noch den Aspekt von Security mit aufgenommen.