Cog-Creators/Red-DiscordBot

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

Open

#5,115 opened on Jun 2, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (2,317 forks)batch import
Category: Cogs - PermissionsHelp WantedStatus: AcceptedType: Feature

Repository metrics

Stars
 (4,337 stars)
PR merge metrics
 (Avg merge 1d 15h) (3 merged PRs in 30d)

Description

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 direction
Examine the 'acl getserver' command implementation and add YAML comments next to IDs showing the corresponding role or member names.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75