Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

108 lines (73 loc) · 2.46 KB

Contributing to Seren Blogs

We welcome contributions to the Seren blog! Whether you're writing about a new publisher integration, sharing a tutorial, or documenting a use case, your contribution helps the community.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your blog post
  3. Write your post following the guidelines below
  4. Submit a pull request

Blog Post Guidelines

File Naming

Use the format: YYYYMMDD_Title-With-Hyphens.md

Example: 20260120_Building-AI-Agents-with-Seren-MCP.md

Structure

Every blog post should include:

# Title

*Brief description or tagline*

---

## Introduction
Hook the reader and explain what they'll learn.

## Main Content
The meat of your post with code examples, diagrams, etc.

## Conclusion
Summarize key points and next steps.

---

*Published: Month Day, Year*
*Tags: #Tag1 #Tag2 #Tag3*

Content Standards

  • Target audience: AI agent developers and software engineers
  • Tone: Technical but approachable
  • Length: 500-2000 words recommended
  • Code examples: Include working code snippets where applicable
  • ASCII diagrams: Use ASCII art for architecture diagrams (see existing posts for examples)

Topics We're Looking For

  • Publisher integrations and tutorials
  • AI agent development patterns
  • Seren MCP use cases
  • x402 payment implementations
  • Database and API workflows
  • Case studies and real-world examples

What to Avoid

  • Marketing fluff without technical substance
  • Outdated or incorrect code examples
  • Plagiarized content
  • Posts unrelated to Seren, AI agents, or developer tools

Code Examples

When including code:

  • Use fenced code blocks with language hints
  • Include comments explaining non-obvious logic
  • Test your code before submitting
  • Show both the request and response where applicable
{
  "publisher": "example-publisher",
  "method": "GET",
  "path": "/api/endpoint"
}

ASCII Art

We encourage ASCII art diagrams for visual explanations. Keep them:

  • 80 characters wide maximum
  • Wrapped in code blocks
  • Simple and readable

Review Process

  1. Submit your PR with a clear description
  2. A maintainer will review for accuracy and style
  3. Address any feedback
  4. Once approved, your post will be merged

Questions?

Thank you for contributing!