Writing a new SIP

This tutorial details of how to write a new SIP and adding it to the website.

How do I submit?

The process to submit is simple:

  • Fork the Scala documentation repository and clone it.
  • Create a new SIP file in the sips/pending/_posts/. Use the S(L)IP template
    • Make sure the new file follows the format: YYYY-MM-dd-{title}.md. Use the proposal date for YYYY-MM-dd.
    • Use the Markdown Syntax to write your SIP.
    • Follow the instructions in the README to build your SIP locally so you can ensure that it looks correct on the website.
  • Create a link to your SIP in the “pending sips” section of index.md.
  • Commit your changes and push them to your forked repository.
  • Create a new pull request. This will notify the Scala SIP team.

SIP Post Format

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 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.

Markdown formatting

Use the Markdown Syntax to write your SIP.

If you would like a starting point, clone the SIP Template in sips/pending/sip-template.md and use that.

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.

After the installation, you need to start up the local server. The README gives a concise explanation on how to do it. When the server is running, view your changes at http://localhost:4000/sips.

Pending SIPs