sip-tutorial.md

layout	title
default	Writing a new SIP

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 in Markdown

First, create a new SIP 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 orginated.
• MM is the current month (01 = january, 12 = decemeber) when the proposal originated.
• dd is the day of the month when the proposal orginated.
• {title} is the title for the SIP.

Markdown formatting

Use the Markdown Syntax to write your SIP.

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

{% highlight scala %} class Foo {% endhighlight %}

Testing changes

Testing changes requires installing Jekyll.

Use the run-server.sh script locally to ensure your SIP looks correct in the website.