Improve instructions to submit sips #582
Conversation
| * Follow the instructions in the [README](https://github.com/scala/scala.github.com/blob/gh-pages/README.md) 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 to your forked repository | ||
| * Create a new [pull request](https://github.com/scala/scala.github.com/pull/new/gh-pages). This will notify the Scala SIP team. |
There was a problem hiding this comment.
I don't think that link makes sense.
| * Create a new SIP file in the `sips/pending/_posts/`. Use the [S(L)IP template](https://github.com/scala/slip/blob/master/slip-template.md) | ||
| * 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](http://daringfireball.net/projects/markdown/syntax) to write your SIP. | ||
| * Follow the instructions in the [README](https://github.com/scala/scala.github.com/blob/gh-pages/README.md) to build your SIP locally so you can ensure that it looks correct on the website. |
There was a problem hiding this comment.
I think you should refer to the README in the master branch: https://github.com/scala/scala.github.com/blob/master/README.md
| * Use the [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax) to write your SIP. | ||
| * Follow the instructions in the [README](https://github.com/scala/scala.github.com/blob/gh-pages/README.md) 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 to your forked repository |
There was a problem hiding this comment.
I would say "Commit your changes and push them to your forked repository".
But then do you need to also say "clone your fork" after forking?
I think it's safe to assume that anyone proposing language changes knows how to git/GitHub, so I would just keep it to the superficial facts, rather than the technical step-to-step.
There was a problem hiding this comment.
I prefer to keep this as-is. True that it's safe to assume that, but leaving it there doesn't cause any harm.
| @@ -36,4 +45,4 @@ class Foo | |||
|
|
|||
| Testing changes requires installing [Jekyll](http://jekyllrb.com/docs/installation/). Since this site is hosted on github pages, make sure you have [whatever version of Jekyll that github is running](https://help.github.com/articles/using-jekyll-with-pages#troubleshooting). 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](http://localhost:4000/sips). | |||
| Use the `jekyll serve --watch --incremental` command to start up a local server. You can then view your changes at [http://localhost:4000/sips](http://localhost:4000/sips). | |||
There was a problem hiding this comment.
I would defer this to the details in the README rather than duplicate it here - eg. this doesn't mention using Bundler.
|
Your suggestions focus on the previous structure of the instructions, my PR initially didn't aim at more than just porting the instructions from the SIP submission page to the instructions. However, I agree it's better to do it all once, so I've just updated the tutorial. |
|
Huh, my review comments don't collapse given the changes. That sucks. |
No description provided.