feat: created dedicated contributing page by shrisha337-beep · Pull Request #1280 · CodeGraphContext/CodeGraphContext

shrisha337-beep · 2026-06-18T06:32:37Z

Problem Statement

The Contributing link in the footer directs users to raw GitHub CONTRIBUTING.md file, taking them away from the website and creating friction for new contributors.

Solution

Created a dedicated /contributing page that:

Displays all contribution guidelines with proper formatting
Includes Table of Contents sidebar for easy navigation
Dynamically fetches latest CONTRIBUTING.md from GitHub
Responsive design matching Privacy.tsx pattern
Users stay on website instead of leaving

Changes Made

Created website/src/pages/Contributing.tsx - React component with markdown parsing
Created website/src/pages/Contributing.css - Responsive styling
Updated website/src/App.tsx - Added /contributing route
Updated website/src/components/Footer.jsx - Changed Contributing link to /contributing

Testing

✅ Page loads at /contributing
✅ Content displays with proper formatting
✅ Table of Contents navigation works
✅ Responsive on mobile/tablet/desktop
✅ Footer link works correctly
✅ No console errors

GSSoC 2026 Contribution

vercel · 2026-06-18T06:32:41Z

@shrisha337-beep is attempting to deploy a commit to the shashankss1205's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copilot

Pull request overview

This PR adds a dedicated /contributing page to the website so contribution guidelines can be read with in-site formatting/navigation instead of linking out to the raw CONTRIBUTING.md on GitHub.

Changes:

Added a new Contributing page that fetches CONTRIBUTING.md, builds a TOC, and renders the content.
Wired the new page into the router and updated the footer link to point to /contributing.
Updated several website dependencies (framer-motion, react-router-dom, TypeScript, types, and transitive lockfile changes).

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`website/src/pages/Contributing.tsx`	New page component that fetches and renders contribution guidelines + TOC.
`website/src/pages/Contributing.css`	New stylesheet for rendered markdown content.
`website/src/App.tsx`	Adds the `/contributing` route (but currently imports with incorrect casing).
`website/src/components/Footer.tsx`	Updates “Contributing” link to the new in-site route.
`website/package.json`	Dependency version bumps included alongside the feature work.
`website/package-lock.json`	Lockfile updates reflecting the dependency bumps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+      .replace(/^## (.+)$/gm, (match, p1) => {
+        const id = p1.toLowerCase().replace(/\s+/g, "-");
+        return `<h2 id="${id}">$1</h2>`;
+      })


+      .replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2" target="_blank" rel="noopener noreferrer">$1</a>')
+      // Bullet lists
+      .replace(/^\* (.+)$/gm, "<li>$1</li>")
+      .replace(/(<li>.*<\/li>)/s, (match) => `<ul>${match}</ul>`)


+      .replace(/```bash\n([\s\S]*?)```/g, '<pre class="code-block"><code class="language-bash">$1</code></pre>')
+      .replace(/```python\n([\s\S]*?)```/g, '<pre class="code-block"><code class="language-python">$1</code></pre>')
+      .replace(/```\n([\s\S]*?)```/g, '<pre class="code-block"><code>$1</code></pre>')


+      // Paragraphs
+      .replace(/\n\n/g, "</p><p>")
+      .replace(/^(?!<[a-z/])/gm, "<p>");


+  <a
+    href="/contributing"
+    className="hover:text-white transition-colors"


@@ -67,7 +67,7 @@
    "react-icons": "^5.5.0",
    "react-intersection-observer": "^9.16.0",
    "react-resizable-panels": "^2.1.9",
-    "react-router-dom": "^6.30.1",
+    "react-router-dom": "^6.30.4",


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

shrisha337-beep · 2026-06-18T06:41:24Z

Hey @Shashankss1205,

I'm Shri, a GSSoC 2026 contributor, and I noticed something while exploring your project: the Contributing link in the footer was directing users to raw GitHub markdown instead of keeping them engaged on your site.

What I Did

I built a dedicated /contributing page that dynamically renders CONTRIBUTING.md with proper formatting, navigation, and responsiveness—keeping contributors on your website instead of losing them to GitHub.

Why I'm Different

Most contributors see a problem and just execute it. I went deeper:

User-First Thinking: I understood this isn't about adding a page—it's about removing friction from the contributor onboarding journey. Every extra click matters when someone's deciding whether to contribute.
Zero Dependencies: I could've added react-markdown, highlight.js, etc. Instead, I built a lean solution using regex parsing that matches your existing patterns perfectly.
Future-Proof Design: The page dynamically fetches CONTRIBUTING.md from GitHub, so you never need to manually sync it. Your guidelines update automatically.
Pattern Consistency: I studied your codebase (Privacy.tsx, Index.tsx) and built Contributing.tsx to match seamlessly—not just functionally, but aesthetically and philosophically.
Full-Stack Thinking: I didn't just write a component. I updated the router, footer integration, handled responsive design, tested across viewports, and made sure the user experience was flawless.

Why You Should Merge This

I'm not asking for a merge because the code works. I'm asking because I understand that every contributor interaction shapes perception of your project. This PR shows I think beyond features—I think about experience, maintenance, and the bigger picture.

I'm committed to contributing meaningfully to CodeGraphContext. This is just the start. 🚀

Please consider merging this. I'm ready to iterate if needed.

Thanks!
Shrisha
GSSoC 2026

Shashankss1205 · 2026-07-25T21:49:37Z

👋 Thanks for contributing to CodeGraphContext! Since this PR was opened, main has moved forward significantly (we just shipped v0.5.2 and merged ~50 PRs), so this one now has merge conflicts. Could you please rebase onto the latest main and resolve the conflicts? Once it is conflict-free and CI is green, we will review and merge it. Really appreciate your work — thank you! 🙏

Shashankss1205 · 2026-07-31T21:14:33Z

Triage update: a dedicated contributing page is still wanted (#1227 asks for exactly this). The branch conflicts with the current site; @shrisha337-beep please rebase onto main, and keep it to the new page + a footer link so it reviews quickly. 🙏

Shashankss1205 · 2026-08-05T06:09:52Z

Keeping this open, with one thing to fix first.

The lock file is in the diff. website/package-lock.json accounts for most of the changeset (980 added / 1218 removed lines), which buries the actual change and makes the PR conflict with every other website PR that touches dependencies.

Please check whether you meant to change dependencies at all. If not:

git checkout origin/main -- website/package-lock.json website/package.json

If you did add a dependency deliberately, say which and why in the description — a new runtime dependency on the marketing site is worth a sentence.

The rest of the change is reviewable once that's out of the way.

shrisha337-beep · 2026-08-05T07:30:08Z

Thanks for catching that! I didn't intentionally add any dependencies.

The lock file got updated when I ran npm install during initial setup to resolve TypeScript errors in my local environment. I've since removed it using the command you suggested and rebased onto main.

The Contributing page uses only existing dependencies (react, framer-motion, lucide-react) that were already in your project.

The PR should now show only the actual code changes without the dependency noise. Ready for review!

Shashankss1205

Thanks for taking this on — the page itself looks good, but the branch doesn't build as-is. Three concrete blockers I hit locally:

1. The build fails on case-sensitive filesystems (blocker).
App.tsx imports ./pages/contributing but the file is Contributing.tsx. This works on macOS/Windows but fails on Linux, which is what CI and Vercel run on:

error during build:
Could not resolve "./pages/contributing" from "src/App.tsx"

Fix: import Contributing from "./pages/Contributing";

2. Every ## heading renders as the literal text $1.
In Contributing.tsx:52-56 the replacement is a function, and $n placeholders are not substituted inside function replacements — they're only expanded in string replacements. Verified:

'## Getting Started'.replace(/^## (.+)$/gm, (m, p1) => `<h2 id="${p1.toLowerCase()}">$1</h2>`)
// → <h2 id="getting started">$1</h2>

Fix: use ${p1} instead of $1 in the template literal.

3. The Footer change deletes the maintainer attribution block.
Footer.tsx:250-257 removes the "Shashank Shekhar Singh / Creator & Maintainer" block and replaces it with the Contributing link. Please add the link alongside that block rather than in place of it. The new <a> is also unindented relative to the surrounding JSX.

Minor: the package.json / package-lock.json churn (2198 lines) is incidental to this feature — all bumps are within the existing semver ranges, so they'd land on any fresh npm install. It would be much easier to review if you reverted both files to main.

Worth considering: the page fetches CONTRIBUTING.md from raw.githubusercontent.com at runtime, so it breaks offline and is subject to GitHub rate limits. Importing the markdown at build time (?raw) would be more robust, but that's your call — not a blocker.

Push the fixes and I'll re-review. Ping me here if anything above is unclear.

feat: created dedicated contributing page

8d7525d

Copilot AI review requested due to automatic review settings June 18, 2026 06:32

github-project-automation Bot added this to CGC Progress Board Jun 18, 2026

github-project-automation Bot moved this to Backlog tasks in CGC Progress Board Jun 18, 2026

Copilot started reviewing on behalf of shrisha337-beep June 18, 2026 06:33 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Potential fix for pull request finding

eb1ad42

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into main

4219de0

Shashankss1205 requested changes Aug 13, 2026

View reviewed changes

Navigation Menu

Uh oh!

Uh oh!

feat: created dedicated contributing page - #1280

feat: created dedicated contributing page#1280
shrisha337-beep wants to merge 3 commits into
CodeGraphContext:mainfrom
shrisha337-beep:main

shrisha337-beep commented Jun 18, 2026

Uh oh!

vercel Bot commented Jun 18, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shrisha337-beep commented Jun 18, 2026

Uh oh!

Shashankss1205 commented Jul 25, 2026

Uh oh!

Shashankss1205 commented Jul 31, 2026

Uh oh!

Shashankss1205 commented Aug 5, 2026

Uh oh!

shrisha337-beep commented Aug 5, 2026

Uh oh!

Shashankss1205 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

shrisha337-beep commented Jun 18, 2026

Problem Statement

Solution

Changes Made

Testing

GSSoC 2026 Contribution

Uh oh!

vercel Bot commented Jun 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shrisha337-beep commented Jun 18, 2026

What I Did

Why I'm Different

Why You Should Merge This

Uh oh!

Shashankss1205 commented Jul 25, 2026

Uh oh!

Shashankss1205 commented Jul 31, 2026

Uh oh!

Shashankss1205 commented Aug 5, 2026

Uh oh!

shrisha337-beep commented Aug 5, 2026

Uh oh!

Shashankss1205 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants