search

exercism / java

Exercism exercises in Java.
https://exercism.org/tracks/java
MIT License
677 stars 666 forks source link

Add documentation on representations #2717

Closed sanderploegsma closed 5 months ago

sanderploegsma commented 5 months ago

The exercises/shared/.docs/representations.md file contents are displayed in the Automations part of the website used by mentors to set up automated mentor feedback on solution sets grouped by their representations. This is explained here: https://exercism.org/docs/building/tracks/shared-files#h-file-representations-md

Fixes #2699

Reviewer Resources:

Track Policies

sanderploegsma commented 5 months ago

I also noticed that the Elixir track contains more documentation on how these normalizations work: https://github.com/exercism/elixir/blob/d0f255138e0b13eb81e364e2ab6c3a9aa498e540/exercises/shared/.docs/representations.md

I'd like to add this as well, but since the representer might be overhauled soon after merging https://github.com/exercism/java-representer/pull/109 I'd like to hold off on that for now.

manumafe98 commented 5 months ago

I'd like to add this as well, but since the representer might be overhauled soon after merging exercism/java-representer#109 I'd like to hold off on that for now.

Do you think we should go ahead and merge this representation until the change is merged or we should wait?

sanderploegsma commented 5 months ago

Currently this file describes the representer as it is running right now, so I'd say we merge this.