Contributing to Radhika's PlacePrep

Thank you for your interest in contributing to R's PlacePrep! This guide will help you get started.

Ways to Contribute

There are two main ways to contribute to R's PlacePrep:

Content Contribution - Add questions, fix typos, improve documentation
Code Contribution - Fix bugs, add features, improve performance

Content Contribution

Adding Company Questions

Questions are stored as markdown files in the content/companies/ directory.

Directory Structure


content/companies/
├── tcs/
│   ├── aptitude/
│   ├── coding/
│   └── 2025-nqt/
├── infosys/
│   └── 2025-irt/
└── accenture/
    └── 2025-nlt/

Question Format

markdown
## Question Title

Question text goes here...

**Options:**
1. First option
2. Second option
3. Third option
4. Fourth option

**Answer:** 2

**Explanation:**
Detailed explanation of why option 2 is correct.

**Difficulty:** Medium
**Topic:** Topic Name

Adding PYQ (Previous Year Questions)

University PYQ papers are stored in the content/pyq/ directory, organized by branch, subject, and year.

PYQ Directory Structure


content/pyq/
└── cse/
    ├── coa/
    │   ├── 2022/
    │   │   └── questions.md
    │   └── 2023/
    │       └── questions.md
    ├── os/
    │   └── 2023/
    │       └── questions.md
    ├── daa/
    │   ├── 2022/
    │   └── 2023/
    ├── dm/
    │   └── 2022/
    ├── de/
    │   └── 2023/
    └── hrdob/
        ├── 2022/
        └── 2023/

PYQ Markdown Format

Each questions.md file should follow this structure:

markdown
---
title: Subject Name - End Semester YEAR
description: BEU B.Tech Semester X End Semester Examination YEAR
university: Bihar Engineering University, Patna
courseCode: "XXXXXX"
semester: IV
totalMarks: 70
duration: 03 Hours
lastUpdated: 2025-02-09
---

# Subject Name

End Semester Examination - YEAR | Bihar Engineering University, Patna

**Instructions:**
- The marks are indicated in the right-hand margin.
- Attempt FIVE questions in all.
- Question No. 1 is compulsory.

---

## MCQ Section

### Q1: Multiple Choice Questions (Any Seven) [2 × 7 = 14]

**Q1(a): Sub-question Title**

Question text here...

- (i) Option A
- (ii) Option B
- **(iii) Correct Option** ✓
- (iv) Option D

**Answer:** (iii) Correct Option

**Solution:** Explanation of the correct answer.

---

## Long Answer Questions

### Q2: Question Title [14]

Question description here...

**(a)** Part A of the question [7]

**(b)** Part B of the question [7]

**Answer:**

Detailed answer for the question...

How to Add a New Subject

Create the folder structure: content/pyq/[branch]/[subject-slug]/[year]/questions.md
Add the subject to src/types/pyq.ts:
- Add the slug to SUBJECT_SEMESTER_MAP with the semester number
- Add the display name to SUBJECT_NAMES
Follow the markdown format above
Include **Answer:** and **Solution:** markers for all questions

PYQ Content Guidelines

Sections: Use ## Section Name for paper sections (MCQ, Part A, Part B, etc.)
Questions: Use ### Q1: Title [Marks] format for individual questions
Sub-questions: Use **Q1(a):** for MCQ sub-parts or **(a)** for long answer sub-parts
Answers: Always mark with **Answer:** so the platform can detect and highlight them
Solutions: Add **Solution:** for detailed explanations
MCQ Correct Option: Bold the correct option and add ✓ mark

Steps to Add Questions

Fork the repository
Navigate to the appropriate company/category folder
Edit the existing .md file or create a new one
Follow the format above
Commit your changes with a descriptive message
Submit a pull request

Content Guidelines

Accuracy: Ensure questions and answers are correct
Clarity: Write clear, unambiguous questions
Formatting: Follow the markdown format exactly
Attribution: Don't copy questions from copyrighted sources
Language: Use professional, grammatically correct English

Improving Documentation

Help make our documentation better:

Fix typos and grammatical errors
Add missing information
Clarify confusing sections
Add examples and screenshots
Update outdated information

Documentation files are located in content/docs/

Code Contribution

Prerequisites

Node.js 20+ or Bun
Git
Code editor (VS Code recommended)
Basic knowledge of Next.js, React, and TypeScript

Development Setup

Fork and Clone

bash
git clone https://github.com/YOUR-USERNAME/radhika-placeprep.git
cd radhika-placeprep

Install Dependencies
```
bash
bun install
```
Environment Setup
- Copy .env.example to .env.local
- Configure Appwrite credentials
- Set up required environment variables
Run Development Server
```
bash
bun dev
```
Open Browser
- Navigate to http://localhost:3000

Making Changes

Create a Branch

bash
git checkout -b feature/your-feature-name

Make Your Changes
- Write clean, readable code
- Follow existing code style
- Add comments for complex logic
- Test your changes thoroughly

Commit Changes

bash
git add .
git commit -m "feat: add your feature description"

Commit Message Format:

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code style changes
refactor: Code refactoring
test: Adding tests
chore: Maintenance tasks

Push to GitHub

bash
git push origin feature/your-feature-name

Create Pull Request
- Go to GitHub repository
- Click "New Pull Request"
- Describe your changes
- Link related issues
- Submit for review

Code Guidelines

Code Style

Use TypeScript for type safety
Follow Next.js best practices
Use functional components with hooks
Keep components small and focused
Use meaningful variable names

File Organization


src/
├── app/           # Next.js app router pages
│   ├── companies/ # Company question pages
│   ├── pyq/       # PYQ pages (branch/semester/subject)
│   ├── exam/      # Exam mode pages
│   ├── dashboard/ # Student dashboard
│   └── admin/     # Admin panel
├── components/    # React components
│   ├── landing/   # Landing page components
│   ├── pyq/       # PYQ-specific components
│   ├── exam/      # Exam components
│   └── ui/        # Shared UI components
├── lib/           # Utility functions
│   ├── pyq-loader.ts    # PYQ content loading
│   ├── pyq-export.ts    # PYQ PDF/Word export
│   ├── companies.ts     # Company configuration
│   └── ai/              # AI evaluation
├── types/         # TypeScript types
│   ├── pyq.ts     # PYQ types & config
│   └── exam.ts    # Exam types
└── hooks/         # Custom React hooks
content/
├── companies/     # Company question content (markdown)
├── pyq/           # PYQ content organized by branch/subject/year
└── docs/          # Documentation (markdown)

Component Structure

typescript
'use client' // If client component

import { useState } from 'react'
import type { ComponentProps } from '@/types'

interface MyComponentProps {
  title: string
  onAction: () => void
}

export function MyComponent({ title, onAction }: MyComponentProps) {
  const [state, setState] = useState(false)

  return (
    <div>
      <h1>{title}</h1>
      {/* Component content */}
    </div>
  )
}