Writing a new SIP or SLIP

This tutorial details of how to write a new SIP and adding it to the website. Currently two mechanisms of providing a new SIP are recommended:

  • Using Markdown
  • Using Google Docs.

Writing a SIP/SLIP in Markdown

First, create a new SIP/SLIP file in the pending/_posts directory. Make sure the new file follows the format: YYYY-MM-dd-{title}.md. Where: * YYYY is the current year when the proposal originated. * MM is the current month (01 = January, 12 = December) when the proposal originated. * dd is the day of the month when the proposal originated. * {title} is the title for the SIP or SLIP.

Markdown formatting

Use the Markdown Syntax to write your SIP/SLIP.

If you would like a starting point, clone the SLIP Template in sips/pending/slip-template.md and use that. For now (as we don’t have a specific SIP template) you can also use this for SIPs, just rename it to a SIP in the title and change the layout: field at the top to sip (instead of slip) to make sure it shows up in the right lists.

See the source for this document (sip-tutorial.md) for how to do syntax highlighting.

class Foo

Testing changes

Testing changes requires installing Jekyll. Since this site is hosted on github pages, make sure you have whatever version of Jekyll that github is running. As of the writing of this README, that is version >= 1.0.x.

Use the jekyll server command to start up a local server. You can then view your changes at http://localhost:4000/sips.