Skip to content

CONTRIBUTING: remind about adding to config.json #495

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.

Sign up for GitHub

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

Merged
petertseng merged 1 commit into from
Jan 17, 2017
Merged

CONTRIBUTING: remind about adding to config.json #495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,12 @@ The exercise should consist of, at minimum:
* A test suite
* A reference solution that passes the test (see [#reference-solution](#reference-solution))

Each language track might have additional requirements; check the README in
You will need to add the exercise to `"exercises"` section of the `config.json` file in the track.
The order in which the exercises are listed there is the order in which they are fetched by default by `exercism fetch`.
Typically, exercises are ordered by difficulty, unless there is a particular reason to do otherwise.
Copy link
Member Author

@petertseng petertseng Jan 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am hoping this sentence doesn't conflict with any track that may wish to specify a different ordering? I think it is true that in the steady state all tracks want to order their exercises by difficulty, but I seem to remember some track that requested its contributors put new exercises at the end of the track temporarily, and they'll move them to the right spot later after seeing how difficult it seems for students. But alas, I didn't note down what track that was and I do not seem to be able to find it...

Copy link
Contributor

@Insti Insti Jan 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xruby puts new exercises at the end.

The reasoning being that new exercises may have weird errors or ambiguities, and it is better that these are encountered first by the (presumably more experienced) programmers who are working on the later problems, in the hope they will raise GitHub issues for them. Once they have a few successful solutions they can be moved to a more appropriate place in the order.

Copy link
Contributor

@Insti Insti Jan 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also isolates the discussion about where a particular problem fits in the order.

Copy link
Member Author

@petertseng petertseng Jan 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this, it may not be safe for this document to make a blanket prescription on exercise ordering. I am considering three choices:

  1. Delete this line; do not replace.
  2. Delete this line; replace with "Please check with the track to which you are submitting an exercise for guidance on how to order the exercises".
  3. Append the above "Please check"... sentence to this line.

Copy link
Contributor

@Insti Insti Jan 14, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☑️ 2 3

It's a good idea to document the typical ordering here.

Copy link
Member Author

@petertseng petertseng Jan 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tentatively applying choice 3, since I also think it seems good to document what's typical, and since I think the main concern is with any tracks that wish to do differently, and if you like 3 I'll hope any others will as well.


Each language track might have additional guidance on how to order their
exercises or additional requirements on new exercise files; check the README in
the repository for the track.

### Providing Feedback on the Site for an Exercise You Implemented
Expand Down