Przeglądaj źródła

Fix policies doc anchor links

Stuart Kent 9 lat temu
rodzic
commit
bc731d81bd
1 zmienionych plików z 26 dodań i 14 usunięć
  1. 26
    14
      POLICIES.md

+ 26
- 14
POLICIES.md Wyświetl plik

@@ -26,28 +26,40 @@ Our policies are not set-in-stone. They represent directions chosen at a point i
26 26
 
27 27
 ## Policy Descriptions
28 28
 
29
-### Prefer instance methods [[1](https://github.com/exercism/xjava/issues/177#issuecomment-261291741)]
29
+### Prefer instance methods
30 30
 
31
-Most (all?) exercises should be implemented in the form of instance methods since they contain "domain logic" and we (Exercism) want to encourage exemplary software.
31
+> Most (all?) exercises should be implemented in the form of instance methods since they contain "domain logic" and we (Exercism) want to encourage exemplary software.
32 32
 
33
-### Starter implementations [[1](https://github.com/exercism/xjava/issues/178)]
33
+References: [[1](https://github.com/exercism/xjava/issues/177#issuecomment-261291741)]
34 34
 
35
-- Exercises 1-10: provide stubs for all required methods.
36
-- Exercises 11-20: provide stubs for all methods required by the first test; comment-out the bodies of any tests that require non-stubbed methods.
37
-- Exercises 21+: provide no stubs, but mention any "interesting" interface aspects in the HINT.md file (which gets merged into the README.md for the exercise).
35
+### Starter implementations
38 36
 
39
-### Ignore noninitial tests [[1](https://github.com/exercism/xjava/issues/101#issuecomment-249349204)]
37
+> - Exercises 1-10: provide stubs for all required methods.
38
+> - Exercises 11-20: provide stubs for all methods required by the first test; comment-out the bodies of any tests that require non-stubbed methods.
39
+> - Exercises 21+: provide no stubs, but mention any "interesting" interface aspects in the HINT.md file (which gets merged into the README.md for the exercise).
40 40
 
41
-All but the first test in an exercise test suite should be annotated `@Ignore`.
41
+References: [[1](https://github.com/exercism/xjava/issues/178)]
42 42
 
43
-### Multiple file submissions [[1](https://github.com/exercism/xjava/issues/365#issuecomment-292533120)]
43
+### Ignore noninitial tests
44 44
 
45
-The first exercise in the track whose test suite mandates multiple solution files should be accompanied by a HINT.md file reminding the practitioner that the CLI supports multiple file submissions.
45
+> All but the first test in an exercise test suite should be annotated `@Ignore`.
46 46
 
47
-### Good first patches [[1](https://github.com/exercism/xjava/issues/220#issue-196447088)]
47
+References: [[1](https://github.com/exercism/xjava/issues/101#issuecomment-249349204)]
48 48
 
49
-Aim to keep 10-20 small and straightforward issues open at eny given time. Identify any such issues by applying the "Good first patch" label.
49
+### Multiple file submissions
50 50
 
51
-### Simple onboarding [[1](https://github.com/exercism/xjava/issues/395#issue-215734887)]
51
+> The first exercise in the track whose test suite mandates multiple solution files should be accompanied by a HINT.md file reminding the practitioner that the CLI supports multiple file submissions.
52 52
 
53
-The Installing Java instructions should seek to minimize the number of steps and the number of concepts a new-to-the-track practitioner needs to learn to get to coding.
53
+References: [[1](https://github.com/exercism/xjava/issues/365#issuecomment-292533120)]
54
+
55
+### Good first patches
56
+
57
+> Aim to keep 10-20 small and straightforward issues open at eny given time. Identify any such issues by applying the "Good first patch" label.
58
+
59
+References: [[1](https://github.com/exercism/xjava/issues/220#issue-196447088)]
60
+
61
+### Simple onboarding
62
+
63
+> The Installing Java instructions should seek to minimize the number of steps and the number of concepts a new-to-the-track practitioner needs to learn to get to coding.
64
+
65
+References: [[1](https://github.com/exercism/xjava/issues/395#issue-215734887)]