Skip to content

Docs/add contributing guide - #697

Closed
Nareshkumawat-star wants to merge 6 commits into
Dev-Card:mainfrom
Nareshkumawat-star:docs/add-contributing-guide
Closed

Docs/add contributing guide#697
Nareshkumawat-star wants to merge 6 commits into
Dev-Card:mainfrom
Nareshkumawat-star:docs/add-contributing-guide

Conversation

@Nareshkumawat-star

Copy link
Copy Markdown
Contributor

Summary

This Pull Request introduces a comprehensive CONTRIBUTING.md guide in the repository root to help new contributors set up the project locally, understand the monorepo architecture, follow branch naming conventions, and adhere to PR quality checklists. Additionally, it fixes a bug in the backend GET /api/events/:slug endpoint that was causing a test failure by exposing the missing organizerId field in the response.


#Closes : #619

Type of Change

  • Bug fix
  • New feature
  • Refactor (no functional change)
  • UI / Design change
  • Tests only
  • Documentation
  • Infrastructure / DevOps
  • Security

What Changed

  • CONTRIBUTING.md (root): Added a new structured contributing guide containing a monorepo project overview, prerequisite software requirements, step-by-step local setup guide, branch naming conventions (feat/, fix/, docs/, chore/), PR quality checklist, and an issue labels guide.
  • apps/backend/src/routes/event.ts: Modified the EventDetails type and updated the GET /:slug endpoint response mapping to include organizerId: details.organizerId. This resolves the assertion error in the backend test suite where organizerId was received as undefined.
  • Other codebase alignments: Staged and committed local typescript formatting and import cleanups (such as migrating to node:crypto imports) to ensure they are tracked.

How to Test

  1. Run the backend Vitest test suite to verify that all 293 tests (including the previously failing event details tests) pass successfully:
    npm run test

@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the Prashantkumar Khatri's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added backend gssoc:approved Required label for every approved PR. Gives the base +50 points and enables contribution tracking. labels Jul 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Hi @Nareshkumawat-star,

Thanks for opening this pull request.

This PR has been automatically classified based on the files modified.

Applied Labels

  • gssoc:approved
  • backend
  • web

Primary Review Area

  • backend

Reviewer

@Harxhit has been identified as the primary reviewer for this pull request.

If you have any questions regarding the affected area or implementation details, feel free to reach out to the assigned reviewer.

Thank you for your contribution!

@github-actions github-actions Bot added the web label Jul 15, 2026
@github-actions

github-actions Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

CI — All Checks Passed

Backend — PASS

Check Result
Lint PASS
Test PASS
Typecheck PASS

Mobile — SKIP

Check Result
Lint -
Test -

Web — PASS

Check Result
Build PASS

Last updated: Wed, 15 Jul 2026 16:07:53 GMT

@ShantKhatri

Copy link
Copy Markdown
Collaborator

This PR is deviated from the issue. Closing this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend gssoc:approved Required label for every approved PR. Gives the base +50 points and enables contribution tracking. web

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add CONTRIBUTING.md with local dev setup guide for web and mobile

2 participants