Add comprehensive GitHub project documentation

[Copilot]

📝 Pull Request

📋 Description

Adds a complete production-ready documentation suite including README with badges, contributing guidelines, security policy, code of conduct, issue templates, and PR template.

🔗 Related Issue

Fixes #1

🏷 Type of Change

• feat – New feature
• fix – Bug fix
• docs – Documentation changes
• style – Code style changes (formatting, etc.)
• refactor – Code refactoring
• perf – Performance improvements
• test – Adding or updating tests
• build – Build system or dependency changes
• ci – CI/CD configuration changes
• chore – Maintenance tasks
• revert – Reverting previous changes

📝 Summary of Changes

Root-level documentation:

• README.md — Complete rewrite with shields.io badges, installation/usage instructions, folder structure, tech stack, and dependency listings (auto-detected from both package.json files)
• LICENSE — MIT license
• CONTRIBUTING.md — Fork/contribute workflow, code style, commit conventions
• SECURITY.md — Vulnerability reporting policy
• CODE_OF_CONDUCT.md — Contributor Covenant v2.1

GitHub templates:

• .github/ISSUE_TEMPLATE/bug_report.yml — YAML issue form with severity, environment, logs
• .github/ISSUE_TEMPLATE/feature_request.yml — YAML issue form for enhancements
• .github/ISSUE_TEMPLATE/config.yml — Disables blank issues, adds contact links
• .github/pull_request_template.md — PR checklist template

💭 Motivation and Context

Repository lacked standard open-source documentation. This provides contributors with clear guidelines and maintainers with structured issue/PR workflows.

🧪 How Has This Been Tested?

Documentation-only changes — validated markdown syntax and file structure.

Test Environment:

• N/A (documentation)

Test Steps:

1. Verified all files created in correct locations
2. Confirmed shields.io badge URLs use correct owner/repo

📸 Screenshots (if applicable)

N/A

✅ Checklist

• My code follows the project's code style guidelines
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have run npm run lint and fixed any issues
• I have run npm run build successfully
• New and existing tests pass locally
• Any dependent changes have been merged and published

⚠️ Breaking Changes

• This PR introduces breaking changes

Description of breaking changes:

N/A

📚 Additional Notes

The folder structure in README reflects actual filenames including the Reveiw_page.jsx typo present in the repo — intentionally kept accurate rather than "correcting" it in documentation.

Original prompt

📄 Complete GitHub Project Documentation Generator (Ultimate Prompt)

You are tasked with generating a complete and professional documentation setup for ANY GitHub repository I provide.

Global rule for existing files:

• Do not overwrite existing files. If a target file already exists in the repository (in the root or .github directory), leave it as-is and only create the missing ones.
• This skip-existing rule applies to: LICENSE, CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, issue templates, and the pull request template.

Your output must include:

---

1️⃣ README.md

The README must follow this exact structure and style:

• Project Title (use repo name dynamically).

• Badges Section (centered at the top). Use Shields.io dynamically with repo details:

md

• Short Project Description (auto from repo metadata).

• 🔗 Links Section (Demo / Docs / Issues / Contributing).

• 📑 Table of Contents.

• 🚀 Installation (prerequisites + setup steps).

• ⚡ Usage Examples (CLI / API / UI depending on repo type).

• ✨ Features.

• 📂 Folder Structure (auto-generated from repo).

• 📦 Submodules Section

  • If the repo includes Git submodules / sub repos, list them explicitly with links and short descriptions.

  • Example:

    md

    📦 Submodules

    • auth-service → Handles authentication & JWT.
    • ui-library → Shared React component library.

• 🤝 Contributing → link to CONTRIBUTING.md.

• 📜 License → link to LICENSE.

• 🛡 Security → link to SECURITY.md.

• 📏 Code of Conduct → link to CODE_OF_CONDUCT.md.

• 🛠 Tech Stack:

  • Auto-detect frameworks, libraries, languages, databases, tools, services.

  • Represent each with a Shields.io badge:

    md
    

  • Group into categories:

    • Languages
    • Frameworks & Libraries
    • Databases
    • DevOps / CI / Tools
    • Cloud / Hosting

• 📦 Dependencies & Packages:

  • Auto-detect and list ALL project dependencies used in this repository, similar to the Tech Stack, displayed as badges (“boxes”). Include package names and their current versions where possible.
  • Clearly separate:
    • Runtime Dependencies
    • Dev Dependencies
    • Peer/Optional Dependencies (if applicable)
  • Detection sources by ecosystem:
    • Node.js: package.json (dependencies, devDependencies, peerDependencies, optionalDependencies), plus lockfiles (package-lock.json, yarn.lock, pnpm-lock.yaml).
    • Python: requirements.txt, requirements/*.txt, pyproject.toml (Poetry/PEP 621), poetry.lock, setup.cfg, setup.py, Pipfile, Pipfile.lock.
    • Java: pom.xml (Maven), build.gradle / build.gradle.kts (Gradle), gradle.lockfile.
    • .NET: .csproj/.fsproj, Directory.Packages.props, packages....

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.