Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

64 lines (38 loc) · 2.58 KB
Raw

PyLadies Blog Guest Post Guidelines

We accept guest posts for the PyLadies blog. Here is a guest post that you should read as samples of what we're looking for:

Topics

We're looking for posts about Python and the ladies doing cool things with it. Our audience includes both experts and newer programmers. If you're writing a more expert level post, consider pointing newer programmers to resources to get started with.

Note: we reserve the right to decline posts, or work to improve the work of the post.

Attribution

Cite your courses! Either link to them in your post, or the old-fashioned academic Chicago MLA style of "quoting someone's work"(Root) with an entry for "Root" at the bottom of your post (or any ohter MLA styling).

Also Please include whether:

  1. You want to be noted as the author
  2. If so, what name you want to use
  3. If we can link to you somehow, either through Twitter handle, email, or website.

Anonymous submissions are fine.

Length

Posts should be 500 words in length. If your post is much longer (thousands of words), consider whether it could be broken into two connected posts.

Images

If you wish to include images, they must be 500 pixels wide or less. You must own the images you're submitting, or they must be available under a Creative Commons license.

Formatting

  1. Write your guest post in Markdown (Suggestion: Mou.app for mac is created for Markdown - gives you a preview while you write) (Suggestion #2: http://dillinger.io/ is a web app that provides a live preview when you're writing in Markdown).

A cheatsheet for Markdown commands is at http://daringfireball.net/projects/markdown/syntax.

  1. The very top of the blog post needs the following (including the three dashes before and after the layout/title/tags):
---
layout: post.html
title: "Your title here"
tags: [list, of relevant, tags]
author: Name, or blank/none
author_link: Twitter/Blog/etc or blank/none
---

Submission Method

To submit your post:

  1. Save the file in _posts.

  2. Test your changes locally. Start up mynt as per the instructions in our README.

  3. Make sure that your changes look good, and that there are no errors or formatting issues. If you find problems, stop mynt, make the changes, restart, and check the site again.

When you submit a pull request, everyone with commit access for Pyladies will see it.