Skip to content

Commit 3a5f68e

Browse files
add submodule explanation
1 parent 365ff5d commit 3a5f68e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ Run the following commands from inside the project root directory to install the
1414

1515
```shell
1616
npm install
17-
git submodule update --init --recursive
17+
git submodule update --init --recursive # add/update a local copy of the problem-specification submodule
1818
```
1919

20+
To automate the creation of practice exercise tests, our track tooling consumes data from the the [problem specifications][exercism-problem-specifications-link] submodule. Because these specifications serve as the canonical source for all Exercism tracks, any upstream updates ensure our test cases remain consistent with the global exercise standard.
21+
2022
If you have format on save enabled for JSON files, it is recommended to disable this feature. Alternatively save JSON files with `Ctrl+K s` to save without applying formatting rules.
2123

2224
### Running the development environment
@@ -149,3 +151,4 @@ If you find this documentation is inaccurate or incomplete, or can be improved i
149151
[github-fork-pr-link]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
150152
[exercism-pr-docs-link]: https://exercism.org/docs/building/github/contributors-pull-request-guide
151153
[exercism-contributing-docs-link]: https://exercism.org/docs/building
154+
[exercism-problem-specifications-link]: https://github.com/exercism/problem-specifications

0 commit comments

Comments
 (0)