Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (79 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 2.39 KB

📝 How to Submit a Blog Post

We welcome contributions from the community! Our blog is fully open-source, and anyone can submit a post via GitHub Pull Request.

Quick Start

  1. Fork this repository
  2. Copy content/blogs/0template.md to content/blogs/your-title.md
  3. Edit your copied file with your content
  4. Open a Pull Request
  5. Community reviews your post
  6. Merged = Published! 🎉

Blog Template

Use the ready-to-copy template file:

cp content/blogs/0template.md content/blogs/your-title.md

Then update the copied file fields (title, author, authorGithub, date, excerpt, tags) and replace the content.

If you prefer, here is the same template inline:

---
title: "Your Awesome Title"
author: "Your Name"
authorGithub: "your-github-username"
date: 2026-02-14
excerpt: "A brief description of your post (1-2 sentences)"
tags:
  - tutorial
  - javascript
thumbnail: /assets/images/your-image.jpg  # optional
layout: blog.njk
---

Your content here. Use standard Markdown!

## Subheadings

Regular paragraphs with **bold** and *italic* text.

### Code Blocks

\`\`\`javascript
function hello() {
  console.log("Hello, BLEU!");
}
\`\`\`

### Lists

- Item one
- Item two
- Item three

Guidelines

  • ✅ Write about tech, learning, open-source, or community topics
  • ✅ Keep it respectful and constructive
  • ✅ Include code examples where helpful
  • ✅ Use clear, descriptive titles
  • ✅ Add a thumbnail image if possible (16:9 ratio recommended)
  • ❌ No promotional/spam content
  • ❌ No plagiarized content

File Naming

Name your file using kebab-case:

  • ✅ getting-started-with-rust.md
  • ✅ my-open-source-journey.md
  • ❌ My Blog Post.md
  • ❌ post1.md

Adding Images

  1. Put images in src/assets/images/
  2. Reference them as /assets/images/your-image.jpg

Review Process

  1. Open your Pull Request
  2. Maintainers review for quality and guidelines
  3. You may receive feedback or suggestions
  4. Once approved, your PR is merged
  5. GitHub Actions builds and deploys automatically
  6. Your blog is live within minutes!

Local Development

cd BLEU-Website
npm install
npm run dev

Site will be available at http://localhost:8080

Questions?

  • Open an issue on GitHub
  • Join our Discord and ask in #blog-submissions

Thanks for contributing to the BLEU community! 💙