Просмотр исходного кода

Merge pull request #958 from FridaTveit/UpdateNewExerciseGuideVersion

Update new exercise guide to mention version file
Stuart Kent 9 лет назад
Родитель
Сommit
eb5ab2636e
1 измененных файлов: 8 добавлений и 0 удалений
  1. 8
    0
      CONTRIBUTING.md

+ 8
- 0
CONTRIBUTING.md Просмотреть файл

@@ -164,5 +164,13 @@ See [The Problem Submodules](#the-problem-submodules) section for what needs to
164 164
 The `build.gradle` file can just be copied from any other exercise submodule.
165 165
 See the [POLICIES doc](https://github.com/exercism/java/blob/master/POLICIES.md#starter-implementations) for an explanation of when you need to add a starter implementation.
166 166
 
167
+4. Check if there is canonical data for the exercise you're adding.
168
+This can be found at `https://github.com/exercism/problem-specifications/tree/master/exercises/EXERCISE-SLUG/canonical-data.json`.
169
+If there is canonical data for your exercise then you should follow this when making the tests.
170
+We aim to follow the canonical data as closely as possible in our tests to ensure thorough test coverage.
171
+If there is canonical data available you also need to create a file at `exercises/exercise-slug/.meta/version` specifying the canonical data version you have implemented (e.g. `1.0.0`).
172
+The canonical data version can be found at the top of the canonical data file for that exercise.
173
+See other exercises, e.g. [acronym](https://github.com/exercism/java/tree/master/exercises/acronym/.meta), for an example `version` file.
174
+
167 175
 Hopefully that should be enough information to help you port an exercise to the Java track.
168 176
 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.