Skip to content

Commit 6ecd164

Browse files
authored
docs: add shared exercise docs (#39)
1 parent 69db5e1 commit 6ecd164

File tree

2 files changed

+8
-29
lines changed

2 files changed

+8
-29
lines changed

exercises/shared/.docs/help.md

+3-18
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,6 @@
11
# Help
22

3-
<!-- TODO: write document
3+
If you're stuck on something, it may help to look at some of the [available resources](https://exercism.org/docs/tracks/sqlite/resources) or ask [The Exercism Community on Discord](https://exercism.org/r/discord).
44

5-
This document should contain track-specific instructions on how to get help when
6-
the student is stuck.
7-
8-
The instructions should be short and to the point.
9-
10-
You could link to resources like Gitter channels, forums or mailing lists:
11-
whatever can help a student become unstuck.
12-
13-
This document should **not** link to Exercism-wide (track-agnostic) help resources,
14-
as those resources will automatically be included in the HELP.md file.
15-
16-
The links in this document can overlap with those in docs/LEARNING.md or docs/RESOURCES.md
17-
18-
When a student downloads an exercise via the CLI, this file's contents are
19-
included into the HELP.md file.
20-
21-
See https://exercism.org/docs/building/tracks/shared-files for more information. -->
5+
Additionally, [StackOverflow](http://stackoverflow.com/questions/tagged/sqlite) is a good spot to search for your problem/question to see if it has been answered already.
6+
If not, you can always [ask](https://stackoverflow.com/help/how-to-ask) or [answer](https://stackoverflow.com/help/how-to-answer) someone else's question.

exercises/shared/.docs/tests.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
# Tests
22

3-
<!-- TODO: write document
3+
Navigate to the directory containing the appropriate `${slug}-test.sql` file, where `${slug}` is the name of the exercise, using hyphens instead of spaces and all lowercase (e.g. `hello-world-test.sql` for the `Hello World` exercise).
44

5-
This document should contain instructions on how to run the exercise's tests.
5+
```bash
6+
sqlite3 -bail < ${slug}-test.sql
7+
```
68

7-
The instructions should be short and to the point.
8-
9-
The docs/TESTS.md file can contain a more verbose description on how to run tests.
10-
11-
When a student downloads an exercise via the CLI, this file's contents are
12-
included into the HELP.md file.
13-
14-
See https://exercism.org/docs/building/tracks/shared-files for more information.
15-
-->
9+
You can find more information in the [sqlite track docs about testing](https://exercism.org/docs/tracks/sqlite/tests).

0 commit comments

Comments
 (0)