Bladeren bron

Add reference tutorial policy

We have decided that every exercise with diffulty less than 3 should
reference the hello world tutorial to make it easier for people to solve
those exercises. This has now been added to our policies doc.

We also now reference those policies in the contributing doc in the section
for adding new exercises.
Frida Johanne Tveit 8 jaren geleden
bovenliggende
commit
7f0938ae62
2 gewijzigde bestanden met toevoegingen van 13 en 3 verwijderingen
  1. 3
    1
      CONTRIBUTING.md
  2. 10
    2
      POLICIES.md

+ 3
- 1
CONTRIBUTING.md Bestand weergeven

@@ -145,7 +145,7 @@ Any completely new exercise needs to be added and accepted there before it can b
145 145
 
146 146
 There is a [general Exercism guide for porting an exercise to a new language](https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md).
147 147
 Please review this before porting an exercise to the Java track.
148
- 
148
+
149 149
 See [here](http://exercism.io/languages/java/todo) for a list of exercises that have yet to be implemented on the Java track and can therefore be ported to this track.
150 150
 Please make sure no one else has a pull request open to implement your chosen exercise before you start.
151 151
 Also please make a [dibs pull request](https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md#avoiding-duplicate-work) to make it clear to others that you are working on this exercise.
@@ -180,5 +180,7 @@ If there is canonical data available you also need to create a file at `exercise
180 180
 The canonical data version can be found at the top of the canonical data file for that exercise.
181 181
 See other exercises, e.g. [acronym](https://github.com/exercism/java/tree/master/exercises/acronym/.meta), for an example `version` file.
182 182
 
183
+* Make sure you've followed the [track policies](https://github.com/exercism/java/blob/master/POLICIES.md), especially the ones for exercise added/updated.
184
+
183 185
 Hopefully that should be enough information to help you port an exercise to the Java track.
184 186
 Feel free to open an issue or post in the [Gitter exercism/java room](https://gitter.im/exercism/java) if you have any questions and we'll try and answer as soon as we can.

+ 10
- 2
POLICIES.md Bestand weergeven

@@ -17,7 +17,7 @@ Our policies are not set-in-stone. They represent directions chosen at a point i
17 17
 
18 18
 | Track Event | Policies to review |
19 19
 |:------------|:-----------------|
20
-| Exercise added/updated | [Prefer instance methods](#prefer-instance-methods); [Avoid using final](#avoid-using-final); [Adhere to best practices](#adhere-to-best-practices); [Starter implementations](#starter-implementations); [Ignore noninitial tests](#ignore-noninitial-tests); [Multiple file submissions](#multiple-file-submissions); [Name test class after class under test](#name-test-class-after-class-under-test); [Add hint for the first exercises without starter implementation](#add-hint-for-the-first-exercises-without-starter-implementation)
20
+| Exercise added/updated | [Prefer instance methods](#prefer-instance-methods); [Avoid using final](#avoid-using-final); [Adhere to best practices](#adhere-to-best-practices); [Starter implementations](#starter-implementations); [Ignore noninitial tests](#ignore-noninitial-tests); [Multiple file submissions](#multiple-file-submissions); [Name test class after class under test](#name-test-class-after-class-under-test); [Add hint for the first exercises without starter implementation](#add-hint-for-the-first-exercises-without-starter-implementation); [Reference tutorial in the first exercises](#reference-tutorial-in-the-first-exercises)
21 21
 | Track rearranged | [Starter implementations](#starter-implementations); [Multiple file submissions](#multiple-file-submissions) |
22 22
 | New issue observed in track | [Good first patches](#good-first-patches) |
23 23
 | "Good first patch" issue completed | [Good first patches](#good-first-patches) |
@@ -74,7 +74,7 @@ References: [[1](https://github.com/exercism/java/issues/395#issue-215734887)]
74 74
 
75 75
 ### Name test class after class under test
76 76
 
77
-> If you're testing a class called `SomeClassName` then your test class should be called `SomeClassNameTest`. 
77
+> If you're testing a class called `SomeClassName` then your test class should be called `SomeClassNameTest`.
78 78
 
79 79
 > The exception to this is if the tests are split into several test classes where each test class tests different functionality. In that case each class should be named `SomeClassNameFunctionalityTest` where `Functionality` is the name of the functionality to be tested in that class. See the [clock exercise](https://github.com/exercism/java/tree/master/exercises/clock) as an example.
80 80
 
@@ -93,3 +93,11 @@ References: [[1](https://github.com/exercism/java/issues/697)]
93 93
 > We add the file to every exercise with difficulty 5 because the structure of the track means that we don't know which exercise will be the first one without starter implementation that a user will be faced with.
94 94
 
95 95
 References: [[1](https://github.com/exercism/java/issues/1075)]
96
+
97
+### Reference tutorial in the first exercises
98
+
99
+> The hello world exercise has an extensive tutorial on how to solve exercism exercises.
100
+> This tutorial would probably be useful to have as a reference when solving some of the other earlier exercises as well.
101
+> Therefore any exercise with difficulty less than 3 should have a hints.md file which references [the hello world tutorial](https://github.com/exercism/java/blob/master/exercises/hello-world/TUTORIAL.md).
102
+
103
+References: [[1](https://github.com/exercism/java/issues/1389)]