Skip to content

Rename constants to match their guild counterparts#782

Merged
lemonsaurus merged 19 commits into
masterfrom
feat/backend/b496/rename-constants
Feb 28, 2020
Merged

Rename constants to match their guild counterparts#782
lemonsaurus merged 19 commits into
masterfrom
feat/backend/b496/rename-constants

Conversation

@MarkKoz
Copy link
Copy Markdown
Contributor

@MarkKoz MarkKoz commented Feb 23, 2020

Resolves #496

Contributors will have an easier time configuring the constants if their names line up with the names in the guild. Not all names were changed to be exact; mostly the staff-only channels were left alone since they were already adequately descriptive.

  • Use underscores for spaces (mostly changed the log channel names)
  • Roles and channels were "split" by category in the config by putting comments above different "categories"
  • Some unused constants were removed

@MarkKoz MarkKoz added t: feature New feature or request a: backend Related to internal functionality and utilities (error_handler, logging, security, utils and core) p: 2 - normal Normal Priority status: needs review labels Feb 23, 2020
@MarkKoz MarkKoz requested a review from a team as a code owner February 23, 2020 20:29
@MarkKoz MarkKoz requested review from ikuyarihS and manusaurio and removed request for a team February 23, 2020 20:29
They no longer exist in the guild.

* Move devlog under the "Logs" category
It makes the code which uses it more readable. A comment was added to
explain the discrepancy between the constant's name and the name in the
guild.
They used to only be loaded in "debug mode" because the main guild was
used to test the bot. However, we have since moved to using a separate
test guild so it's no longer a concern if these cogs get loaded.

It was confusing to some contributors as to why these cogs were not
being loaded since the debug mode isn't really documented anywhere.
@MarkKoz MarkKoz force-pushed the feat/backend/b496/rename-constants branch from c0ac17f to 14536f8 Compare February 23, 2020 20:41
MarkKoz and others added 5 commits February 23, 2020 13:05
Lists were getting too long to be readable as one line. Having each
element on a separate line also reduces merge conflicts.
This name better explains what the list is for.
Delete duplicate keys that were missed in the merge
@sco1
Copy link
Copy Markdown
Contributor

sco1 commented Feb 25, 2020

I've resolved the merge conflict & added the role & channel groupings to the YAML that were only present in constants.py.

I still need to test the changes but I'm not currently at a machine capable of doing so.

@MarkKoz MarkKoz requested a review from jb3 February 25, 2020 17:42
@sco1 sco1 force-pushed the feat/backend/b496/rename-constants branch from 6867cc5 to 284c1de Compare February 25, 2020 18:34
@sentry
Copy link
Copy Markdown

sentry Bot commented Feb 27, 2020

Sentry issue: BOT-1W

Copy link
Copy Markdown
Contributor

@lemonsaurus lemonsaurus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks excellent. This will make them much more intuitive to work with.

Copy link
Copy Markdown
Contributor

@Akarys42 Akarys42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes please!

@lemonsaurus lemonsaurus merged commit e2f9cdd into master Feb 28, 2020
@lemonsaurus lemonsaurus deleted the feat/backend/b496/rename-constants branch February 28, 2020 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a: backend Related to internal functionality and utilities (error_handler, logging, security, utils and core) p: 2 - normal Normal Priority t: feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

updating/upgrading contributing bot tutorial

4 participants