search

exercism / raku

Exercism exercises in Raku
https://exercism.org/tracks/raku
MIT License
22 stars 33 forks source link

Launch Checklist #30

Open kytrinyx opened 8 years ago

kytrinyx commented 8 years ago

Launch Checklist

Step 0: Prep the Repo (@kytrinyx)

Step 1: Implement Exercises

See the contributing guide for the details about the format of an exercise.

The short version is:

The topics can be an empty list, and the difficulty level is from 1 to 10, and can default to 1 until we know more about the exercises.

"exercises": [
  {
    "slug": "hello-world" ,
    "difficulty": 1,
    "topics": []
  }
]

Step 2: Add the Track to Exercism (@kytrinyx)

This means that it will show up on http://exercism.io/languages and http://exercism.io/languages/perl6

Step 3: Make the Track Ready for Launch

test_pattern

The exercism.io website links to the exercise implementations, so it needs to know how to recognize the filename(s) for the test suite.

The "test_pattern" value in the config.json file should be a string that can be compiled as a regular expression, and which will match on the file or files that comprise the test suite of an exercise.

If the test filenames contain the word "test" (case insensitive) then the "test_pattern" key can be deleted.

Language Icon and Attribution

We try to create a language icon that has the exercism colors, and is recognizably similar to the language icon. Sometimes this isn't possible due to copyright issues.

The Exercism colors are:

The icon is used throughout the site in order to identify the language track, and to identify code that has been submitted to that track.

See http://exercism.io/languages for all the existing icons.

Icon

If image assets are not your strong suit, just find a reasonable image to start from, along with the information about the licensing, and we'll figure out the colorization thing (I've written some scripts to help me do this part).

The logo should be named icon.png and live under img/ in this repository. If you know how, go ahead and make an SVG as well.

Attribution

The attribution goes in the README.md file.

If the icon we have based this on is not in the public domain, we need to provide information about license and provenance. If we require permission to use and/or change the icon, then we need to obtain that permission before we can use it.

Documentation

The documentation is used in the http://exercism.io/languages/perl6 section to help people get started with the track.

The files live in the docs/ directory here in this repository, and gets served to the site via the x-api. It should contain at minimum:

Some nice to haves:

Find Track Mentors

Usually in order to see someone's solution you have to have submitted the exercise yourself. Track mentors can access all of the solutions in a given language. Track mentors can therefore help review solutions that people submit on the website in the beginning when few people have submitted solutions to exercises.

Ideally we should have a handful of people who are willing to check Exercism regularly to give people feedback, in order to start the track off on the right note.

The first track mentor needs to be added manually by @kytrinyx, but after that there's a section in the account where existing track mentors can invite new ones.

The most successful tracks are where each submission receives feedback quickly, preferably within the first 24 hours.

In addition, the most interesting and useful conversations start when reviewers do not direct users to do specific things, but rather ask questions challenging people to think about different aspects of their solution, or explore aspects of the language.

Referencing existing blog posts and style guides seems to work well when making specific recommendations.

Prepare for Open Source Contributions

Once the track is live and active, it will often get new contributions.

We've got a few years of experience maintaining language tracks on Exercism. Here's what we have learned:

There's more stuff in the contributing guide, as well. We're working on turning that into better, more focused maintainer documentation.

Launch!

m-dango commented 8 years ago

test_pattern included in https://github.com/exercism/xperl6/pull/42

m-dango commented 7 years ago

@kytrinyx Could you add me to the perl 6 track mentors on the site?

kytrinyx commented 7 years ago

Done!

m-dango commented 7 years ago

I think the track is in a good state for becoming active at this point. Hopefully when it does it'll attract a few more contributors to the repository šŸ™‚

m-dango commented 7 years ago

Created PR https://github.com/exercism/xperl6/pull/158 for toggling active to true

kytrinyx commented 7 years ago

@mienaikage Do you go to any Perl 6 meetups or hang out in any Perl 6 forums or chatrooms? If so, would you see if you can entice anyone else to come help keep an eye on things here (review PRs, discuss issues) and/or on the website (give people feedback)? If we could get 2 or 3 people involved, that would ensure that people can have vacations and babies and mid-life crises without the track suffering from it.

m-dango commented 7 years ago

There is the #perl6 IRC channel, I'll let people on there know that the track is going live and see if I can tempt a few people to jump on.

There's also a Perl social in London coming up on 8th June so I may go along to that.

kytrinyx commented 7 years ago

Both of those sound great!

kotp commented 7 years ago

Not to mention the Gitter Room on Exercism for perl!, but I want to...

m-dango commented 7 years ago

Posted on the IRC and the Perl 6 Facebook group. The site also got a mention in the Perl 6 weekly blog šŸ™‚

kytrinyx commented 7 years ago

The site also got a mention in the Perl 6 weekly blog

Very cool!