Add copilot-instructions.md for GitHub Copilot repository context

[Copilot]

This PR adds a comprehensive copilot-instructions.md file to provide GitHub Copilot with detailed context about the ninja-api-key repository.

What's included

The file provides GitHub Copilot with essential information about:

• Project Overview: Django package for API Key authentication with Django Ninja framework
• Key Components: APIKey model, APIKeyAuth class, and security features
• Code Patterns: Django integration conventions, pytest testing patterns, and code style (Black, Ruff)
• Development Patterns: Dependencies, key generation flow, and authentication process
• Common Use Cases: Practical code examples for basic and endpoint-specific API protection
• Testing Guidelines: Security testing best practices and fixture usage
• File Structure: Overview of main modules and their purposes

Benefits

This will help GitHub Copilot:

• Generate code that follows Django and Django Ninja conventions
• Understand the security-first approach of API key management
• Suggest appropriate testing patterns using pytest-django
• Follow established code style and formatting rules
• Provide context-aware suggestions for authentication flows

The instructions are based on the official GitHub documentation for repository custom instructions.

Fixes #54.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

Pull Request Overview

This PR adds a new copilot-instructions.md file to give GitHub Copilot detailed context about the ninja-api-key repository.

• Introduces project overview, core components, and security features
• Outlines code patterns, development workflows, and testing guidelines
• Provides common use case examples and file structure documentation

Comments suppressed due to low confidence (3)

copilot-instructions.md:100

• [nitpick] The 'Testing Guidelines' section overlaps with the earlier '### Testing' subsection under 'Code Patterns'. Consider merging them or renaming to avoid redundancy and clarify the document structure.

## Testing Guidelines

copilot-instructions.md:113

• The test directory path is earlier specified as ninja_apikey/tests/. For consistency, update this path to ninja_apikey/tests/ or clarify its location relative to the project root.

- `tests/`: Comprehensive test suite

copilot-instructions.md:35

• [nitpick] Consider using the American English spelling 'parameterized' to align with common Python conventions and pytest terminology, or ensure consistent usage across the documentation.

- Use parametrized tests for multiple scenarios

[lucasrcezimbra]

pre-commit.ci autofix

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.73%. Comparing base (16b3c2e) to head (e1db3d8).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #55   +/-   ##
=======================================
  Coverage   94.73%   94.73%           
=======================================
  Files          11       11           
  Lines         266      266           
=======================================
  Hits          252      252           
  Misses         14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.