Skip to content

[Feature] Add Contributing Documentation Page and Link It in Footer #1227

Closed

Description

@ArshiBansal

Description

Currently, the footer contains a Contributing link, but it does not direct users to a centralized page containing contribution guidelines and documentation. New contributors often need a single source of truth for information related to project contributions.

To improve contributor onboarding and accessibility of documentation, create a dedicated Contributing page that displays all contribution-related guidelines (typically sourced from CONTRIBUTING.md) and link the footer's Contributing button to this page.

Proposed Changes

  • Create a dedicated route/page for contribution guidelines.
  • Populate the page with content from CONTRIBUTING.md or equivalent documentation.
  • Update the footer's Contributing link to redirect users to this page.
  • Ensure the page is responsive and follows the project's existing design system.

Expected Behavior

When a user clicks on the Contributing link in the footer, they should be redirected to a page that contains:

  • Contribution workflow
  • Setup instructions
  • Coding standards
  • Pull request guidelines
  • Issue reporting guidelines
  • Any other contributor-related documentation

Benefits

  • Improves contributor onboarding experience.
  • Makes contribution guidelines easily discoverable.
  • Reduces confusion for first-time contributors.
  • Provides a centralized location for all contribution-related resources.

Acceptance Criteria

  • A dedicated contribution documentation page is created.
  • The page displays all relevant contribution guidelines.
  • Footer's Contributing link redirects to the new page.
  • Page is responsive across devices.
  • Content remains synchronized with CONTRIBUTING.md (if applicable).

Labels

  • GSSoC'26
  • Enhancement
  • Documentation
  • Good First Issue

Activity

  1. github-actions commented on Jun 12, 2026

    @github-actions
    Contributor

    Hi! 👋 Join our CodeGraphContext Discord channel to collaborate: https://discord.gg/dR4QY32uYQ

  2. ArshiBansal commented on Jun 12, 2026

    @ArshiBansal
    ContributorAuthor

    @Shashankss1205 please assign this

  3. bidi158 commented on Jun 14, 2026

    @bidi158

    Hi, I am a contributor and would like to work on this issue. Could you please assign it to me?

  4. ArshiBansal commented on Jun 15, 2026

    @ArshiBansal
    ContributorAuthor

    @Shashankss1205 please assign this

  5. PalakSharma111 commented on Jun 18, 2026

    @PalakSharma111

    Hi! I am a beginner and I want to work on creating the Contributing Documentation page and linking it in the footer. This will help new contributors. Please assign this issue to me.

  6. PalakSharma111 commented on Jun 22, 2026

    @PalakSharma111

    /assign

  7. added
    gssoc:approvedGSSoC validation: counts toward scoring
    level:beginnerGSSoC difficulty: 20 pts contributor / 10 mentor
    mentor:Shashankss1205GSSoC mentor attribution: credits reviewing mentor
    type:featureGSSoC type bonus: feature
    on Sep 24, 2026
  8. Shashankss1205 commented on Oct 15, 2026

    @Shashankss1205
    Collaborator

    Maintenance review — 15 October 2026

    Use the repository's contribution guide as the source of truth and wire the footer to a real route/page. Check the route, relative links and mobile navigation; avoid another divergent copy of setup instructions.

  9. Shashankss1205 commented on Oct 15, 2026

    @Shashankss1205
    Collaborator

    The dedicated page exists, but its document fetch and primary footer link still referenced a removed root CONTRIBUTING.md. Fixed in #1779: both footer links now use /contributing; the page loads the canonical .github/CONTRIBUTING.md and correctly resolves the testing-guide link. Production build and actual React page/footer loading, success and error-state checks pass. CI is running.

  10. moved this from Backlog tasks to In progress in CGC Progress Boardon Oct 15, 2026
  11. Shashankss1205 commented on Oct 15, 2026

    @Shashankss1205
    Collaborator

    Fixed and merged in #1779 after all current-head CI checks and Vercel deployment passed. The production/combined website builds and actual React component checks pass. Both footer links now use the working contribution page, which loads the current canonical guidelines and resolves the testing guide correctly.

  12. moved this from In progress to Done in CGC Progress Boardon Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    gssoc:approvedGSSoC validation: counts toward scoringlevel:beginnerGSSoC difficulty: 20 pts contributor / 10 mentormentor:Shashankss1205GSSoC mentor attribution: credits reviewing mentortype:featureGSSoC type bonus: feature

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions