Cog-Creators/Red-DiscordBot

[Permissions] Add comments to 'acl getserver' yaml displaying what the ID relates to

Offen

#5.115 geöffnet am 02.06.2021

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (2.317 Forks)batch import
Category: Cogs - PermissionsHelp WantedStatus: AcceptedType: Feature

Repository-Metriken

Stars
 (4.337 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Type of feature request

Command

Description of the feature you're suggesting

With [p]permissions acl getserver I think it'd be handy if YAML comments could show what the IDs relate to, as a lot of the time I end up looking them up manually. Server roles at the least would be nice, but it could extend to members too.

Anything else?

No response

Contributor Guide

Research-Richtung
Untersuche den Befehl `[p]permissions acl getserver` in der Red DiscordBot Codebasis. Die YAML Ausgabe wird in einer Datei im Zusammenhang mit Berechtigungen generiert, z. B. `redbot/cogs/permissions/`. Suche nach der Methode, wie Rollen IDs und Mitglieder IDs mithilfe des Bot Caches oder API Aufrufen auf Namen abgebildet werden. Füge YAML Kommentare hinzu, die die Rollennamen neben den Rollen IDs und optional die Mitgliedernamen neben den Benutzer IDs anzeigen. Überprüfe vorhandene Kommentare im Issue auf Hinweise zu Implementierungsdetails.
Tech Stack
python
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75