diff --git a/README.md b/README.md index c7a5022..4114f3c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Benchmark Task Studio -A frontend-only React application that demonstrates how real-world coding benchmark tasks can be **authored, reviewed, and validated**. +A React frontend for reviewing benchmark tasks with a clean UI and mock data. -This project simulates the workflow used in AI evaluation and developer benchmarking platforms, using mocked task data (no backend or authentication). +This project simulates the workflow used in AI evaluation and developer benchmarking platforms, demonstrating how real-world coding benchmark tasks can be **authored, reviewed, and validated**. --- diff --git a/REPOSITORY_SETTINGS.md b/REPOSITORY_SETTINGS.md new file mode 100644 index 0000000..74e135b --- /dev/null +++ b/REPOSITORY_SETTINGS.md @@ -0,0 +1,99 @@ +# Repository Settings Update Guide + +This document provides instructions for updating the GitHub repository description and topics. + +## ✅ Completed Updates + +The following files have been updated to include the new description and topics: + +1. **package.json**: Added `description` and `keywords` fields with the requested content +2. **README.md**: Updated the main description/tagline to match + +## Repository Metadata (GitHub Settings) + +To complete the update, you still need to update the GitHub repository metadata: + +### Repository Description + +Update the repository description to: +``` +A React frontend for reviewing benchmark tasks with a clean UI and mock data. +``` + +### Repository Topics + +Add the following topics: +- `react` +- `typescript` +- `frontend` +- `benchmark` +- `testing` + +--- + +## How to Update (Choose One Method) + +### Method 1: GitHub Web Interface (Recommended) + +1. Go to the repository page: https://github.com/saiajith-muduthanapelli/Benchmark-Task-Studio +2. Click on the ⚙️ gear icon (Settings) next to "About" on the right sidebar +3. In the "Description" field, enter: `A React frontend for reviewing benchmark tasks with a clean UI and mock data.` +4. In the "Topics" section, add each topic: `react`, `typescript`, `frontend`, `benchmark`, `testing` +5. Click "Save changes" + +### Method 2: GitHub CLI (Command Line) + +If you have the GitHub CLI (`gh`) installed and authenticated: + +```bash +# Update repository description +gh repo edit saiajith-muduthanapelli/Benchmark-Task-Studio \ + --description "A React frontend for reviewing benchmark tasks with a clean UI and mock data." + +# Add topics +gh repo edit saiajith-muduthanapelli/Benchmark-Task-Studio \ + --add-topic react \ + --add-topic typescript \ + --add-topic frontend \ + --add-topic benchmark \ + --add-topic testing +``` + +### Method 3: GitHub API (Advanced) + +Using curl or any HTTP client with a GitHub Personal Access Token: + +```bash +# Update description +curl -X PATCH \ + -H "Authorization: token YOUR_GITHUB_TOKEN" \ + -H "Accept: application/vnd.github.v3+json" \ + https://api.github.com/repos/saiajith-muduthanapelli/Benchmark-Task-Studio \ + -d '{"description":"A React frontend for reviewing benchmark tasks with a clean UI and mock data."}' + +# Update topics +curl -X PUT \ + -H "Authorization: token YOUR_GITHUB_TOKEN" \ + -H "Accept: application/vnd.github.mercy-preview+json" \ + https://api.github.com/repos/saiajith-muduthanapelli/Benchmark-Task-Studio/topics \ + -d '{"names":["react","typescript","frontend","benchmark","testing"]}' +``` + +--- + +## Verification + +After updating, verify the changes by: +1. Visiting the repository page and checking the "About" section +2. Running: `gh repo view saiajith-muduthanapelli/Benchmark-Task-Studio --json description,repositoryTopics` + +--- + +## Why These Settings Cannot Be Updated via Git + +Repository description and topics are GitHub metadata stored in GitHub's database, not in the repository files themselves. They cannot be modified by committing changes to files in the repository. They must be updated through: +- GitHub's web interface +- GitHub API +- GitHub CLI + +This is different from repository files like README.md, which are part of the git repository. diff --git a/package.json b/package.json index b7d1f26..4574619 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,14 @@ "private": true, "version": "0.1.0", "type": "module", + "description": "A React frontend for reviewing benchmark tasks with a clean UI and mock data.", + "keywords": [ + "react", + "typescript", + "frontend", + "benchmark", + "testing" + ], "scripts": { "dev": "vite", "build": "tsc -b && vite build",