Skip to content

Commit 5888577

Browse files
Add documentation on representations (#2717)
1 parent cce8452 commit 5888577

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Representations
2+
3+
The [Java representer][github-java-representer] applies the following normalizations:
4+
5+
- All comments are removed
6+
- All import declarations are removed
7+
- Whitespace is normalized
8+
- Identifiers are normalized to a placeholder value
9+
10+
## Before you submit
11+
12+
Please check the following things:
13+
14+
- You don't duplicate feedback given by the analyzer.
15+
- You check the "examples" tab in the submit dialog and see if the feedback makes sense for all tabs.
16+
- You check that you have not referred to whitespace or comments.
17+
- You check that you don't refer to function names, or variable names as they appear in the solution, but rather use the mapping provided (or leave names out).
18+
Only identifiers used by the exercise tests can be safely referred to because these are always the same for everyone.
19+
20+
[github-java-representer]: https://github.com/exercism/java-representer

0 commit comments

Comments
 (0)