Workflow for Adding Mentor Notes

Exercism Exercism Chat
1

I’ve been wanting to add mentor notes on a few exercises that I see come up pretty often.

I’m just wanting to know what is the correct way to go about doing that.

  • The website-copy repo says to open an issue, but that doc is 5 years old.
  • The New Contributing Guide blog post says to post on the forum first (not sure if that’s just for tracks, or if that would apply to mentor notes also).
  • If a note doesn’t exist for an exercise, there’s a link to just create a PR.

Is there a preferred way to do this? Is it a little more casual since it’s copy?

2

Since you’re already here: which exercises for which track would you like to contribute to? Once you tell us, we can tag the relevant maintainer and the post here can then even serve as a link back for the GitHub PRs :slight_smile:

1 Like
3

The exercises that made me start thinking about it were some of the more basic exercises on the Ruby track that pop up a lot.

Amusement Park, Bank Account, Bob, Log Line Parser, etc.

4 Likes
4

@kotp @Meatball I assume you have not issue with people opening mentor note PRs?

@Budmin thanks for wanting to contribute!

1 Like
5

I don’t really have anything against it

6

Would these new mentor notes perhaps be the beginning of some Dig Deeper articles? I’ve got nothing against mentor notes, but they’re only seen by mentors so students don’t directly benefit unless they’re in a mentoring discussion. Dig Deeper articles on the other hand are visible as soon as a student completes the exercise.

Of course, mentor notes and Dig Deeper articles have different audiences and serve different purposes so the material and presentation may not fully transfer over. Mentor notes can be pretty useful, but maybe consider Dig Deeper articles as well if that interests you.

2 Likes
7

I do not have anything against that. I have quite a few mentor notes that I have collected over the last 11 years of Exercism laying around here somewhere…

2 Likes
8

Good point.

@Budmin create your pr and link this topic.

Then, if you like doing this, we can assess if the content is good or partial for a public facing doc!

9

@Budmin please link both directions, helps to maintain communication, some pay attention here more than the repository notifications.

1 Like
10

@kotp @Meatball

Mentor notes for the Bob exercise on the Ruby track.
Any feedback would be well appreciated.

I would be interested in working on a Dig Deeper article. I would plan on adding more approaches, go into more detail on each approach, and naturally change the tone to accommodate the different audience.

Whatever’s best for the platform is fine with me

1 Like
11

I think, generally speaking, dig deeper notes are much higher value than mentoring notes.

2 Likes
12

Hello, I need help with the"Hello, World!" project. I’m 12 and I just started, so I’m having trouble with learningcoding python can anybody please help?

13

This post is off topic :) For the Hello World exercise, you should watch the intro video, use the ... in the top right to reset the code, run the tests to see the test output, then follow the video instructions. If you still need help after that, start a new thread in the Python category. Your post has nothing to do with this topic of mentor notes.