TheLovinator/discord-reminder-bot
1
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Update Copilot instructions

Browse Source
This commit is contained in:
Joakim Hellsén
2025-03-04 23:10:24 +01:00
parent 0a2fd88cc0
commit 3e5e23591d
1 changed files with 3 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.github/copilot-instructions.md vendored
View File

@ -1,14 +1,8 @@
This is a Discord.py bot that allows you to set date, cron and interval reminders with APScheduler. Dates are parsed using dateparser. This is a Discord.py bot that allows you to set date, cron and interval reminders with APScheduler. Dates are parsed using dateparser.
Use type annotation/hints. Use try-except blocks, type hints, f-strings, logging, and Google style docstrings.
Use try-except blocks. Add helpful message when using assert in tests.
Add logging.
Write Google style docstrings.
Add helpful message when using assert. Use f-strings.
Docstrings that doesn't return anything should not have a return section. Docstrings that doesn't return anything should not have a return section.
@ -16,7 +10,7 @@ A function docstring should describe the function's behavior, arguments, side ef
Including the exception object in the log message is redundant. Including the exception object in the log message is redundant.
We use Github. We use GitHub.
Channel reminders have the following kwargs: "channel_id", "message", "author_id". Channel reminders have the following kwargs: "channel_id", "message", "author_id".