Getting Started
Contributing to OpenNotes Hub is easy and rewarding. Follow these steps to add your study materials and help fellow students.
Step 1: Fork the Repository
Start by forking our GitHub repository to your account.
# Clone your forked repository
git clone https://github.com/RelaxItsAryan/Open-Notes-Hub.git
cd opennoteshub
Step 2: Create Your Content
Navigate to the appropriate folder based on what you're contributing:
For Study Notes:
content/
├── cse/
│ ├── sem1/
│ │ ├── mathematics-1/
│ │ │ ├── unit1.md
│ │ │ └── unit2.md
│ │ └── programming/
│ │ └── unit1.md
│ └── sem2/
│ └── ...
For PYQs:
pyqs/
├── cse/
│ ├── data-structures/
│ │ ├── 2023.md
│ │ └── 2022.md
│ └── operating-systems/
│ └── 2023.md
Step 3: Write Your Markdown
Create your content using Markdown format. Here's a template:
---
title: "Unit 1: Introduction to Data Structures"
subject: "Data Structures"
branch: "CSE"
semester: 3
author: "Your Name"
lastUpdated: "2025-12-14"
---
# Unit 1: Introduction to Data Structures
## What are Data Structures?
Data structures are ways of organizing and storing data...
## Types of Data Structures
1. **Linear Data Structures**
- Arrays
- Linked Lists
- Stacks
- Queues
2. **Non-Linear Data Structures**
- Trees
- Graphs
## Code Example
```c
// Example: Array declaration
int arr[5] = {1, 2, 3, 4, 5};
```
Step 4: Commit Your Changes
# Add your files
git add .
# Commit with a descriptive message
git commit -m "Add: Data Structures Unit 1 notes for CSE Sem 3"
# Push to your fork
git push origin main
Step 5: Create a Pull Request
Go to the original repository on GitHub and create a Pull Request from your fork. Our maintainers will review your contribution and merge it!
Writing Guidelines
- Be Clear: Write in simple, easy-to-understand language
- Be Accurate: Double-check facts and formulas
- Use Examples: Include practical examples and code snippets
- Format Well: Use proper headings, lists, and code blocks
- Add Diagrams: Include images/diagrams where helpful
Need Help?
If you have questions or need assistance:
- Open an issue on GitHub
- Check our FAQ section
- Join our community discussions
Thank you! Every contribution, no matter how small, helps students around the world. Your knowledge can make a real difference in someone's academic journey.