Skip to content

docs: add comprehensive README.md for GitQuest#27

Merged
naheel0 merged 2 commits intomainfrom
copilot/create-readme-template
Mar 17, 2026
Merged

docs: add comprehensive README.md for GitQuest#27
naheel0 merged 2 commits intomainfrom
copilot/create-readme-template

Conversation

Copy link
Contributor

Copilot AI commented Mar 17, 2026

The project had a single-line # GitQuest placeholder as its README — no setup instructions, no feature overview, nothing to orient new contributors or users.

Changes

  • Replaced the stub README.md with a full project README covering:
    • Tagline, attention-hook intro, and shields.io badge row (stars, license, issues, PRs welcome, Next.js, .NET)
    • Placeholder demo banner + 3-column preview table (Discover / Leaderboard / Profile)
    • Feature list with emojis, tech stack table (Next.js 16 + ASP.NET Core 8 + SQL Server + GitHub OAuth)
    • Quick Start — single copy-paste block: clone → dotnet runnpm run dev
    • Installation — backend (appsettings.Development.json template with all required keys) + frontend commands
    • Usage — step-by-step flow with concrete API snippets (GET /api/issues/discover?language=typescript, POST /api/issues/{issueId}/claim)
    • "Why GitQuest?" motivation section, contributing workflow, MIT license footer
    • Node.js prerequisite set to 18.18+ to match Next.js 16 requirements

📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Copilot AI changed the title [WIP] Add README.md for project docs: add comprehensive README.md for GitQuest Mar 17, 2026
Copilot AI requested a review from jaseel0 March 17, 2026 05:12
@naheel0 naheel0 marked this pull request as ready for review March 17, 2026 05:26
@github-actions github-actions bot added documentation Improvements or additions to documentation configuration Configuration file changes labels Mar 17, 2026
@naheel0 naheel0 merged commit 607865d into main Mar 17, 2026
11 checks passed
@naheel0 naheel0 deleted the copilot/create-readme-template branch March 17, 2026 05:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

configuration Configuration file changes documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants