Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure Haxe track is ready for v2 launch #41

Closed
1 of 9 tasks
kytrinyx opened this issue Jun 12, 2018 · 10 comments
Closed
1 of 9 tasks

Ensure Haxe track is ready for v2 launch #41

kytrinyx opened this issue Jun 12, 2018 · 10 comments
Assignees

Comments

@kytrinyx
Copy link
Member

kytrinyx commented Jun 12, 2018

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.

  • The track has a page on the v2 site: https://v2.exercism.io/tracks/haxe
  • The track page has a short description under the name (not starting with TODO)
  • The "About" section is a friendly, colloquial, compelling introduction
  • The "About" section follows the formatting guidelines
  • 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
  • Exercises have rough estimates of difficulty
  • Exercises have topics associated with them
  • The first exercise is auto_approve: true

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/haxe/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/haxe/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:

  • Bold
  • Italics
  • Links
  • Bullet lists
  • Number lists

Additionally:

  • Each sentence should be on its own line
  • Paragraphs should be separated by an empty line
  • Explicit <br/> can be used to split a paragraph into lines without spacing between them, however this is discouraged.

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/haxe/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 exercism/meta#104

@davidbruce
Copy link
Contributor

@ErikSchierboom

Is it worth it to work on this ticket when version 3 is available to work on?

@ErikSchierboom
Copy link
Member

@davidbruce Well, it depends a bit on how far along you are with the v2 track :)

@davidbruce
Copy link
Contributor

@ErikSchierboom

Unfortunately, I am not very far at all. I have mostly just been looking at how the Java and C# projects handle things and taking inventory of what I need to do to get this repo up to speed. Is version 3 planning on launching soon, and if it is will non-updated language tracks cease to function?

@ErikSchierboom
Copy link
Member

We don't yet have a definitive release date, but we're working hard on it. Non-updated language tracks will function in v3. They'll be automatically updated to work with the v3 website.

@davidbruce
Copy link
Contributor

Alright in that case I'll work on getting this repo some more exercises. Are there any other useful tools besides the canonical data syncer that I should know about?

@ErikSchierboom
Copy link
Member

The only other useful tool is the configlet tool.

@davidbruce
Copy link
Contributor

Perfect, thanks again Erik.

@Nezteb
Copy link
Contributor

Nezteb commented Oct 27, 2020

For what it's worth, I started working on the v2 track for Haxe back in April and then covid ramped up in the US. I ended up moving across the country and looking for new jobs. I've been holding off on finishing the track until v3 is finished and the Haxe language itself releases a few specific features (slated for end of 2020).

@davidbruce
Copy link
Contributor

@Nezteb Do you have a repo or document with what you started on so that I can take a look at? Also what specific feature of Haxe were you waiting for? I see in the pipeline for features are the asys api, macro forwarding, and coroutines; all of which seem a little out of scope for Exercism. Granted there may be something I'm missing. :)

@davidbruce
Copy link
Contributor

Closing in favor of v3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants