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

Make Copilot Instructions shorter

Browse Source
This commit is contained in:
Joakim Hellsén
2025-03-02 17:46:47 +01:00
parent e32d149722
commit 0a2fd88cc0
1 changed files with 11 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,42 +1,26 @@
This project uses Discord.py.
This is a Discord.py bot that allows you to set date, cron and interval reminders with APScheduler. Dates are parsed using dateparser.
It is a Discord bot that allows you to set date, cron and interval reminders.
Use type annotation/hints.
We use uv for dependency management, so all examples and code snippets should use uv.
Use try-except blocks.
Use type annotation for all Python code examples. Ensure to include type hints for function arguments and return values.
Add logging.
Assume that the reader has an advanced understanding of Python.
Write Google style docstrings.
Use try-except blocks for error handling in all Python code examples.
Add logging to all Python code examples.
Write docstrings for all Python functions and classes.
When using assert, ensure to include a helpful message to assist in debugging. Use f-strings for easier readability and to format error messages dynamically.
Add helpful message when using assert. Use f-strings.
Docstrings that doesn't return anything should not have a return section.
Multi-line docstring summary should start at the first line.
A function docstring should describe the function's behavior, arguments, side effects, exceptions, return values, and any other information that may be relevant to the user.
A function docstring should describe the function's behavior, arguments, side effects, exceptions, return values, and any other information that may be relevant to the user. Ensure to follow Google style docstrings and use type hints extensively in our codebase.
Including the exception object in the log message is redundant.
Public functions should be documented via docstrings to outline their purpose and behavior.
We use Github.
When testing for membership in a static sequence, prefer a set literal over a list or tuple, as Python optimizes set membership tests.
Channel reminders have the following kwargs: "channel_id", "message", "author_id".
When logging exceptions via logging.exception, the exception object is logged automatically. Including the exception object in the log message is redundant and can lead to excessive logging.
For version control, assume we use Git with GitHub, and provide examples using Git best practices.
Reminders are managed with APScheduler.
Channel reminders have the following kwargs: channel_id, message, author_id.
User DM reminders have the following kwargs: user_id, guild_id, message.
Dates will be parsed using dateparser.
User DM reminders have the following kwargs: "user_id", "guild_id", "message".
Bot has the following commands: