feat: add Copilot instructions for project context and guidelines

[nanotaboada]

Add comprehensive Copilot instructions documenting tech stack, architecture patterns, coding standards, and common workflows for the FastAPI project.

---

This change is 

Summary by CodeRabbit

• Documentation
  • Added comprehensive guidance documentation including project overview, architecture, coding guidelines, development procedures, and operational reference materials.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Added a comprehensive Copilot Instructions document at .github/copilot-instructions.md that serves as a centralized reference guide for the python-samples-fastapi-restful project. The document outlines project overview, tech stack, structure, architectural patterns, coding guidelines, and operational guidance without modifying any code or public APIs.

Changes

Cohort / File(s)	Change Summary
Copilot Instructions Documentation \.github/copilot-instructions.md	Added comprehensive Copilot instructions file covering project overview, tech stack, structure, architectural patterns, coding guidelines, file exclusions, commit conventions, local development commands, Docker operations, database details, API endpoints, testing approach, CI/CD workflow, common pitfalls, VS Code configuration, and additional resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• No code logic, API signatures, or functional changes to evaluate
• Documentation-only addition; review focuses on content accuracy and completeness

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding Copilot instructions document with project context and guidelines. It is clear, specific, and directly reflects the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/custom-instructions-for-copilot

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00%	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (4c881cc)	131	119	90.84%
Head commit (dfac596)	131 (+0)	119 (+0)	90.84% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#437)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.65%. Comparing base (4c881cc) to head (dfac596).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #437   +/-   ##
=======================================
  Coverage   89.65%   89.65%           
=======================================
  Files           3        3           
  Lines         116      116           
=======================================
  Hits          104      104           
  Misses         12       12           

Components	Coverage Δ
Services	79.31% <ø> (ø)
Routes	100.00% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

.github/copilot-instructions.md (4)

21-43: Add language specifier to project structure code block.

For consistency and proper syntax highlighting, specify a language for the fenced code block. Use text or plaintext for directory trees.

-```
+```text
 ├── main.py                    # FastAPI app entry point, lifespan handler, router registration

---

65-70: Correct GitHub capitalization.

The official name is "GitHub" (with capital "H").

-Black and flake8 exclude:
+Black and flake8 exclude:
 - `.venv`, `.git`, `.github`, `.pytest_cache`, `__pycache__`

---

161-168: Correct GitHub capitalization in CI/CD section.

The official platform name is "GitHub" with capital "H".

-GitHub Actions workflow (`.github/workflows/python-app.yml`):
+GitHub Actions workflow (`.github/workflows/python-app.yml`):

---

216-222: Wrap bare URLs in markdown link syntax.

For better markdown compliance and link detection, wrap URLs in markdown format.

 ## Additional Resources

 - **Postman Collection**: `postman_collections/python-samples-fastapi-restful.postman_collection.json`
 - **Architecture Diagram**: `assets/images/structure.svg`
-- **FastAPI Docs**: https://fastapi.tiangolo.com/
-- **SQLAlchemy 2.0**: https://docs.sqlalchemy.org/en/20/
-- **Conventional Commits**: https://www.conventionalcommits.org/
+- **FastAPI Docs**: [https://fastapi.tiangolo.com/](https://fastapi.tiangolo.com/)
+- **SQLAlchemy 2.0**: [https://docs.sqlalchemy.org/en/20/](https://docs.sqlalchemy.org/en/20/)
+- **Conventional Commits**: [https://www.conventionalcommits.org/](https://www.conventionalcommits.org/)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4c881cc and dfac596.

📒 Files selected for processing (1)

• .github/copilot-instructions.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

.github/copilot-instructions.md

[uncategorized] ~68-~68: The official name of this software platform is spelled with a capital “H”.
Context: ... and flake8 exclude: - .venv, .git, .github, .pytest_cache, __pycache__ - `ass...

(GITHUB)

---

[uncategorized] ~163-~163: The official name of this software platform is spelled with a capital “H”.
Context: ...I/CD Pipeline GitHub Actions workflow (.github/workflows/python-app.yml): 1. **Lint J...

(GITHUB)

🪛 markdownlint-cli2 (0.18.1)

.github/copilot-instructions.md

21-21: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

220-220: Bare URL used

(MD034, no-bare-urls)

---

221-221: Bare URL used

(MD034, no-bare-urls)

---

222-222: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (1)

.github/copilot-instructions.md (1)

1-222: Excellent comprehensive Copilot instructions document.

This is a well-organized, detailed reference guide that covers all essential aspects of the project—tech stack, architecture, coding standards, workflows, and common pitfalls. The documentation is clear, practical, and will be a valuable resource for developers and Copilot context. The examples are concrete and actionable.