exercism / sml

Exercism exercises in Standard ML.
https://exercism.org/tracks/sml
MIT License
27 stars 35 forks source link

Ensure Standard ML track is ready for v2 launch #99

Closed kytrinyx closed 4 years ago

kytrinyx commented 6 years ago

There are a number of things we're going to want to check before the v2 site goes live. There are notes below that flesh out all the checklist items.

Track landing page

The v2 site has a landing page for each track, which should make people want to join it. If the track page is missing, ping @kytrinyx to get it added.

Blurb

If the header of the page starts with TODO, then submit a pull request to https://github.com/exercism/sml/blob/master/config.json with a blurb key. Remember to get configlet and run configlet fmt . from the root of the track before submitting.

About section

If the "About" section feels a bit dry, then submit a pull request to https://github.com/exercism/sml/blob/master/docs/ABOUT.md with suggested tweaks.

Formatting guidelines

In order to work well with the design of the new site, we're restricting the formatting of the ABOUT.md. It can use:

Additionally:

Code example

If the code example is too short or too wide or too long or too uninteresting, submit a pull request to https://github.com/exercism/ocaml/blob/master/docs/SNIPPET.txt with a suggested replacement.

Exercise metadata

Where the v1 site has a long, linear list of exercises, the v2 site has organized exercises into a small set of required exercises ("core").

If you update the track config, remember to get configlet and run configlet fmt . from the root of the track before submitting.

Topic and difficulty

Core exercises unlock optional additional exercises, which can be filtered by topic an difficulty, however that will only work if we add topics and difficulties to the exercises in the track config, which is in https://github.com/exercism/sml/blob/master/config.json

Auto-approval

We've currently made any hello-world exercises auto-approved in the backend of v2. This means that you don't need mentor approval in order to move forward when you've completed that exercise.

Not all tracks have a hello-world, and some tracks might want to auto approve other (or additional) exercises.

Track mentors

There are no bullet points for this one :)

As we move towards the launch of the new version of Exercism we are going to be ramping up on actively recruiting people to help provide feedback. Our goal is to get to 100%: everyone who submits a solution and wants feedback should get feedback. Good feedback.

If you're interested in helping mentor the track, check out http://mentoring.exercism.io/

# When all of the boxes are ticked off, please close the issue.

Tracking progress in https://github.com/exercism/meta/issues/104

jackhughesweb commented 6 years ago

Things which can already be checked off:

The track has a page on the v2 site: https://v2.exercism.io/tracks/sml The code example gives a good taste of the language and fits within the boundaries of the background image There are exercises marked as core

Things which need to be completed:

snahor commented 6 years ago

@jackhughesweb is there a consensus to determine difficulty?

jackhughesweb commented 6 years ago

@snahor There isn't an exact criteria for difficulty, but the docs describe it as "a rough estimate of the difficulty level of the exercise on a scale of 1 to 10"

sshine commented 4 years ago

I'm closing this issue as all the initial checkboxes have been marked.

Further improvement is due, but after #129 we can say that we do have a v2 core track.