How to Contribute to the Official Python Blog via GitHub

Introduction

The Python Insider Blog has a new home at https://blog.python.org, powered by a Git repository. This move makes it easier than ever for community members to contribute. All 307 posts from the old Blogger platform have been migrated, and existing URLs automatically redirect to the new ones. Your RSS reader should automatically pick up the new feed—if it doesn’t, point it to https://blog.python.org/rss.xml. The biggest change for contributors is that you no longer need a Google account or the Blogger editor. Now, writing a post is as simple as editing Markdown files in a Git repository. This guide walks you through the steps to submit your own post.

What You Need

Before you start, make sure you have the following:

• A GitHub account (free) to fork and submit pull requests.
• Basic knowledge of Git (forking, cloning, committing, pushing).
• A text editor for Markdown files (e.g., VS Code, Sublime Text, Atom, or even Notepad).
• Optionally, Git installed on your local machine for previewing the site (if you want to test locally).
• An idea for a post that fits the blog’s scope: Python releases, core sprints, governance updates, or other official topics.

Step-by-Step Guide to Submitting a Post

Step 1: Fork the Repository

Start by visiting the official blog repository at https://github.com/python/python-insider-blog. Click the Fork button in the top‑right corner to create your own copy of the repository under your GitHub account. This will allow you to make changes without affecting the original project.

Step 2: Create Your Post Directory

On your forked copy, navigate to the content/posts/ directory. Here, each blog post lives in its own folder. Create a new directory using a short, descriptive slug for your post. For example, if you’re writing about Python 3.13 features, you might name it python-313-features. The full path will be content/posts/your-post-slug/. Keep the slug URL-friendly—use lowercase letters, hyphens, and no spaces.

Step 3: Write Your Post in Markdown

Inside your new directory, create a file named index.md. This file contains your entire post in Markdown format, but you also need to include YAML frontmatter at the top. The frontmatter includes metadata between triple dashes:

---
title: Your Post Title
date: 2024-10-01
authors:
  - Your Name
tags:
  - python
  - release
---

After the frontmatter, write the body of your post using standard Markdown. You can use headings, lists, code blocks, and any other Markdown syntax. Keep the content focused on official Python blog topics.

Step 4: Add Images (Optional)

If your post needs images, place them in the same directory as your index.md file. For example, content/posts/your-post-slug/image.png. In your Markdown, reference the image with a relative path like ![alt text](image.png). No special configuration is required—images are served alongside the post.

Step 5: Open a Pull Request

Once your post is ready, commit your changes to your fork and push them to GitHub. Then navigate to the original repository (python/python-insider-blog). You’ll see a banner prompting you to create a pull request from your fork. Click it, provide a clear title and description explaining your contribution, and submit the pull request. The core team will review it, suggest changes if needed, and merge it when everything looks good.

Step 6: (Optional) Preview Locally

If you want to see how your post will look before submitting, you can build the site locally. The repository uses Astro to generate static HTML. Clone your forked repo to your machine, ensure you have Node.js installed, then run npm install and npm run dev. This starts a local server where you can view your post in the context of the full blog. Instructions with more detail are in the repo’s README.

Tips for a Successful Contribution

• Check the existing feed: Even if you’re not contributing right away, update your RSS reader to the new feed URL: https://blog.python.org/rss.xml. Old Blogger URLs automatically redirect, so you won’t miss anything.
• Use alternative editors: If you prefer a visual editor over raw Markdown, the site includes Keystatic CMS when running in development mode. It’s entirely optional but can make formatting easier.
• Report issues: If you find broken links, missing images, or formatting problems from the migration, file an issue on the repository. Pull requests with fixes are also welcome.
• Keep posts concise: The official Python blog values clear, well‑structured content. Aim for a few hundred to a few thousand words.
• Review the README: The repo’s README contains additional details about frontmatter fields, allowed tags, and local development. Read it before submitting to align with the team’s expectations.

We’re excited to have you contribute to the Python Insider Blog. The new Git‑based workflow lowers the barrier and makes it easy for anyone with a GitHub account to share updates with the Python community. Happy writing!