TheLovinator/twitch-drop-notifier
1
Fork 0
Code Issues Actions Packages Releases Activity

Add instructions for GitHub Copilot

Browse Source
This commit is contained in:
Joakim Hellsén
2024-12-09 06:14:42 +01:00
parent 4ff60f97a3
commit a7fc1d9887
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.github/copilot-instructions.md vendored Normal file
View File

@ -0,0 +1,15 @@
# Copilot Instructions
- This project uses Django 5.1 as the web framework.
- Use Python 3.12 or above for all examples and code snippets.
- We use uv for dependency management, so all examples and code snippets should use uv.
- Include type hints in all Python code examples and explanations.
- Organize Python code in accordance with Django conventions, and prefer modern Python features when applicable.
- Assume that the reader has a advanced understanding of Python and Django.
- Dark mode is preferred for design-related examples or suggestions.
- Bootstrap 5 is the preferred CSS framework for design-related examples or suggestions.
- 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.
- Prefetch related objects in Django ORM queries.
- Use database indexes in Django models. Our database is PostgreSQL 17.