exercism / emacs-lisp

Exercism exercises in Emacs Lisp.
https://exercism.org/tracks/emacs-lisp
MIT License
46 stars 43 forks source link

Ensure Emacs Lisp track is ready for v2 launch #88

Closed kytrinyx closed 5 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/elisp/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/elisp/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/elisp/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 that can be checked off:

The track has a page on the v2 site: https://v2.exercism.io/tracks/elisp The first exercise is auto_approve: true

Things that need to be completed:

brandelune commented 5 years ago

What about this for the blurb:

"Emacs Lisp is the extension language of the Emacs text editor and as such one of the most used Lisp dialects in the world. It is used to write full-fledged applications that run within Emacs but also user preference files."

brandelune commented 5 years ago

The "About" section of the page is a bit short. What about something like this:

Emacs Lisp is the language at the core of Emacs, the iconic text editor that is at the beginning of the Free Software movement. Emacs is made of more than a million lines of Emacs Lisp, and all the applications that run inside Emacs (IDEs for various programming languages, games, planners, etc.) are written in Emacs Lisp. User preferences are also lists of Emacs Lisp expressions.

Knowing Emacs Lisp is the first step into Lisp, the second oldest programming language still used (just turned 60 in 2018) and also a language that still influences so many other programming languages.

Quoting the creator of Emacs: "Multics Emacs proved to be a great success — programming new editing commands was so convenient that even the secretaries in his office started learning how to use it. They used a manual someone had written which showed how to extend Emacs, but didn't say it was a programming. So the secretaries, who believed they couldn't do programming, weren't scared off. They read the manual, discovered they could do useful things and they learned to program."

benreyn commented 5 years ago

Great suggestions @brandelune! Care to open up a PR with these changes?

brandelune commented 5 years ago

Done.

As far as I can tell, from the list in: https://github.com/exercism/elisp/issues/88#issuecomment-398729437 the 3 first points have been completed.

There are only the items about the code snippet and the exercises.

Is anybody working on that (I'm just learning elisp, I'm not qualified here)?

benreyn commented 5 years ago

I just skimmed over the checklist, looks like we have everything covered 👍