Skip to content

Commit c021fae

Browse files
Link to best practices more
1 parent 9ab126b commit c021fae

File tree

9 files changed

+29
-10
lines changed

9 files changed

+29
-10
lines changed

building/tooling/analyzers/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can use the following documents to learn more about building an analyzer:
1818
- [Creating a Analyzer from scratch](/docs/building/tooling/analyzers/creating-from-scratch)
1919
- [The Analyzer interface.](/docs/building/tooling/analyzers/interface)
2020
- [How to build a Docker image with Docker for local testing and deployment](/docs/building/tooling/analyzers/docker)
21+
- [Best practices](/docs/building/tooling/best-practices)
2122
- [Writing Analyzer comments](/docs/building/tooling/analyzers/comments)
2223
- [Tagging solutions](/docs/building/tooling/analyzers/tags)
2324
- [Guidance for building an Analyzer](/docs/building/tooling/analyzers/guidance)
24-
- [Best practices](/docs/building/tooling/best-practices)

building/tooling/analyzers/creating-from-scratch.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ These are the steps to get going:
77
1. Check [our repository list for an existing `...-analyzer`](https://github.com/search?q=org%3Aexercism+analyzer&type=repositories) to ensure that one doesn't already exist.
88
2. Scan the [contents of this directory](/docs/building/tooling/analyzers) to ensure you are comfortable with the idea of creating an Analyzer.
99
3. Start a new topic on [the Exercism forum][building-exercism] telling us which language you'd like to create an Analyzer for.
10-
4. Once an Analyzer repo has been created, use [the Analyzer interface document](/docs/building/tooling/analyzers/interface) to help guide your implementation.
10+
4. Once an Analyzer repo has been created for you, use [the Analyzer interface](/docs/building/tooling/analyzers/interface) and [Best practices](/docs/building/tooling/best-practices) documents to help guide your implementation.
1111

12-
We have an incredibly friendly and supportive community who will be happy to help you as you work through this! If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
12+
We have an incredibly friendly and supportive community who will be happy to help you as you work through this!
13+
If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
1314

1415
[building-exercism]: https://forum.exercism.org/c/exercism/building-exercism/125
1516
[exercism-repo]: https://github.com/exercism/exercism

building/tooling/analyzers/interface.md

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ All interactions with the Exercism website are handled automatically. Analyzers
1717
The analyzer gets 100% machine resources for a 20 second window per solution.
1818
After 20 seconds, the process is halted and reports a time-out.
1919

20+
```exercism/note
21+
We highly recommend following our [Performance Best Practices document](/docs/building/tooling/best-practices#h-performance) to reduce the chance of timeouts.
22+
```
23+
2024
## Output format
2125

2226
### analysis.json

building/tooling/docker.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Our [Best Practices page](/docs/building/tooling/best-practices) has lots of tip
1515
The test runner gets 100% CPU with 3GB of memory for a 20 second window per solution.
1616
After 20 seconds, the process is halted and reports a time-out with a 408 error code.
1717

18-
We highly recommend following our [Performance Best Practices document](/docs/building/tooling/best-practices#h-performance) to reduce the chance of timeout occuring.
18+
```exercism/note
19+
We highly recommend following our [Performance Best Practices document](/docs/building/tooling/best-practices#h-performance) to reduce the chance of timeouts.
20+
```
1921

2022
### Stdout/stderr
2123

building/tooling/representers/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ You can use the following documents to learn more about building a representer:
3333

3434
- [Creating a Representer from scratch](/docs/building/tooling/representers/creating-from-scratch)
3535
- [The Representer interface](/docs/building/tooling/representers/interface)
36-
- [How to normalize representations for the highest efficiency](/docs/building/tooling/representers/normalization)
3736
- [How to build a Docker image with Docker for local testing and deployment](/docs/building/tooling/representers/docker)
3837
- [Best practices](/docs/building/tooling/best-practices)
38+
- [How to normalize representations for the highest efficiency](/docs/building/tooling/representers/normalization)

building/tooling/representers/creating-from-scratch.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ These are the steps to get going:
77
1. Check [our repository list for an existing `...-representer`](https://github.com/search?q=org%3Aexercism+representer&type=repositories) to ensure that one doesn't already exist.
88
2. Scan the [contents of this directory](/docs/building/tooling/representers) to ensure you are comfortable with the idea of creating an Representer.
99
3. Start a new topic on [the Exercism forum][building-exercism] telling us which language you'd like to create a Representer for.
10-
4. Once a Representer repo has been created, use [the Representer interface document](/docs/building/tooling/representers/interface) to help guide your implementation.
10+
4. Once a Representer repo has been created for you, use [the Representer interface](/docs/building/tooling/representers/interface) and [Best practices](/docs/building/tooling/best-practices) documents to help guide your implementation.
1111

12-
We have an incredibly friendly and supportive community who will be happy to help you as you work through this! If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
12+
We have an incredibly friendly and supportive community who will be happy to help you as you work through this!
13+
If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
1314

1415
[building-exercism]: https://forum.exercism.org/c/exercism/building-exercism/125
1516
[exercism-repo]: https://github.com/exercism/exercism

building/tooling/representers/interface.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# The Representer Interface
22

3-
All interactions with the Exercism website are handled automatically. Representers have the single responsibility of taking a solution and returning a representation of it. See the [introduction](/docs/building/tooling/representers#introduction) for more information.
3+
All interactions with the Exercism website are handled automatically.
4+
Representers have the single responsibility of taking a solution and returning a representation of it.
5+
See the [introduction](/docs/building/tooling/representers#introduction) for more information.
46

57
## Execution
68

@@ -18,6 +20,10 @@ All interactions with the Exercism website are handled automatically. Represente
1820
The representer gets 100% machine resources for a 20 second window per solution.
1921
After 20 seconds, the process is halted and reports a time-out.
2022

23+
```exercism/note
24+
We highly recommend following our [Performance Best Practices document](/docs/building/tooling/best-practices#h-performance) to reduce the chance of timeouts.
25+
```
26+
2127
## Output format
2228

2329
### representation.txt

building/tooling/test-runners/creating-from-scratch.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ These are the steps to get going:
77
1. Check [our repository list for an existing `...-test-runner`](https://github.com/search?q=org%3Aexercism+test-runner&type=repositories) to ensure that one doesn't already exist.
88
2. Scan the [contents of this directory](/docs/building/tooling/test-runners) to ensure you are comfortable with the idea of creating an Test Runner.
99
3. Start a new topic on [the Exercism forum][building-exercism] telling us which language you'd like to create a Test Runner for.
10-
4. Once a Test Runner repo has been created, use [the Test Runner interface document](/docs/building/tooling/test-runners/interface) to help guide your implementation. There is a [generic test runner repository template](https://github.com/exercism/generic-test-runner/) that you can use to kick-start development.
10+
4. Once a Test Runner repo has been created for you, use [the Test Runner interface](/docs/building/tooling/test-runners/interface) and [Best practices](/docs/building/tooling/best-practices) documents to help guide your implementation.
1111

12-
We have an incredibly friendly and supportive community who will be happy to help you as you work through this! If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
12+
We have an incredibly friendly and supportive community who will be happy to help you as you work through this!
13+
If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
1314

1415
[building-exercism]: https://forum.exercism.org/c/exercism/building-exercism/125
1516
[exercism-repo]: https://github.com/exercism/exercism

building/tooling/test-runners/interface.md

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ All interactions with the Exercism website are handled automatically and are not
1818
The test runner gets 100% CPU with 3GB of memory for a 20 second window per solution.
1919
After 20 seconds, the process is halted and reports a time-out.
2020

21+
```exercism/note
22+
We highly recommend following our [Performance Best Practices document](/docs/building/tooling/best-practices#h-performance) to reduce the chance of timeouts.
23+
```
24+
2125
## Output format
2226

2327
The following fields are supported in `results.json` files:

0 commit comments

Comments
 (0)