Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
231 lines (153 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

231 lines (153 loc) · 2.37 KB

✍️ Contributing a Blog

Welcome contributor! 🚀 Follow this guide to add your blog correctly.

🧾 Step 1: Fork the Repository

  • Click Fork
  • Clone your fork locally

📁 Step 2: Create a Blog Folder

Go to:

content/blogs/

Create a folder:

YYYY-MM-DD-your-blog-title

Example:

2026-04-08-understanding-load-balancing

📝 Step 3: Create index.md

Inside your folder:

index.md

Paste this template:

---
title: "Your Blog Title"
slug: "your-blog-title"

authors:
  - "your-author-id"

date: "2026-04-08"
lastUpdated: "2026-04-08"

type: "member" # or "society"

category: "system-design"
tags: ["tag1", "tag2"]

series:
  name: ""
  part: 1

excerpt: "Short summary of your blog."

cover: "./cover.png"

draft: false
---

## Introduction

Start writing your blog...

👤 Step 4: Add Yourself as Author

Go to:

content/authors/

Create:

your-name.json

Example:

{
  "id": "debatreya-das",
  "name": "Debatreya Das",
  "bio": "Your bio",
  "avatar": "/images/authors/deb.png",
  "socials": {
    "github": "your-github",
    "linkedin": "your-linkedin"
  }
}

🖼️ Step 5: Add Images

Put images inside your blog folder:

content/blogs/your-blog/
   ├── index.md
   ├── cover.png
   ├── diagram1.png

Use them like:

![Architecture Diagram](./diagram1.png)

💻 Step 6: Formatting Guide

Headings

## Section Title

Code Blocks

```java
System.out.println("Hello");
```

Lists

- Item 1
- Item 2

Tables

| Column | Value |
|--------|-------|
| A      | B     |

Links

[Visit Site](https://example.com)

🧮 Math Support

You can write:

$$
E = mc^2
$$

🏷️ Step 7: Choose Category

Use ONLY one of:

  • system-design
  • development
  • ai-ml
  • event
  • case-study
  • projects

🚀 Step 8: Create Pull Request

  • Push your changes
  • Open PR
  • Wait for validation + review

⚠️ Common Mistakes

  • Wrong folder name
  • Missing cover image
  • Invalid category
  • Wrong author ID
  • Broken markdown

🧑‍⚖️ Review Criteria

Your blog should be:

  • Clear and structured
  • Technically correct
  • Well formatted

🎯 Final Tip

Think of your blog as:

“Something a junior would read and actually understand”

Happy writing ✨