-
Notifications
You must be signed in to change notification settings - Fork 19
PR Checklist
These are the things you need to ensure are covered in your PR, otherwise the CODEOWNERS will not approve your PR, not matter how much you ping them to do so on the Discord
The description in the PR is a fair representation of what the PR is about.
The PR is fixing one thing and one thing only.
if you have N variables initialized/used in your function, you should print all of them out to the log using logging module at least once or have a good reason why you aren't.
If your PR is doing something like adding a new line or removing a new line, CODEOWNERS reserve the right to ask that you undo that change unless it was for a specific reason.
git rebase is a good tool to use to remove unnecessary changes
document the following things with the usage of the help command annotations
- The purpose of the command
- If the argument is called with any arguments.
- If it is called with any arguments, please either provide a good enough explanation of the arg that a user can tell what it will do before using the command. adding an example of how to call it with the args is not necessary but good practice.
- Evidence of Testing. [only necessary if adding a text command since the testing guild does not yet support slash commands]
- This one needs to be completed after the PR is opened. At that point, you will go on the channel on the CSSS Wall-E Test Server that was automatically created when the PR was opened and then test the following functionality. Once you had done so, you can leave a comment on the PR stating that you had done the necessary testing.
- Please provide ways to test whatever you just modified on the bot in the Test Cases section so that future PRs can be tested to ensure they dont break your code when merging to master