You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+7-40
Original file line number
Diff line number
Diff line change
@@ -7,57 +7,23 @@ Exercism exercises in Racket.
7
7
8
8
## Contributing
9
9
10
-
Please read about how to [get involved in a track](https://github.com/exercism/docs/tree/master/contributing-to-language-tracks). Also, be sure to read the Exercism [Code of Conduct](https://exercism.org/code-of-conduct).
11
-
12
-
We welcome both improvements to the existing exercises and the addition of new exercises. If you are creating a new exercise from scratch please see [adding new exercises](https://github.com/exercism/docs/blob/master/you-can-help/make-up-new-exercises.md). If you are porting an exercise that exists in other exercism language tracks, see [porting an exercise](https://github.com/exercism/docs/blob/master/you-can-help/implement-an-exercise-from-specification.md).
13
-
14
-
Please note that this track's exercises must conform to the Exercism-wide standards described in the [documentation](https://github.com/exercism/docs/tree/master/language-tracks/exercises). If you're unsure about how to make a change, then go ahead and open an issue on Github.
15
-
16
-
Each exercise should have an example solution, a description file, a test suite and a stub file for the solution declaring the module and exports.
17
-
18
-
### Naming Conventions
19
-
20
-
The example solution should be named `example.rkt`. The description file: `README.md`. The test suite: `<exercise-name>-test.rkt`, and the stub: `<exercise-name>.rkt`.
21
-
22
-
For example, if you were to work on the `binary` exercise, you would create and commit the following four files:
23
-
24
-
```bash
25
-
$ racket/exercises/binary/
26
-
.
27
-
├── binary.rkt
28
-
├── binary-test.rkt
29
-
├── README.md
30
-
└── example.rkt
31
-
```
10
+
Please see the [contributing guide](https://exercism.org/docs/building). We welcome both improvements to the existing exercises and the addition of new exercises.
32
11
33
12
### Code Style
13
+
34
14
The Racket code in this repo is meant to conform with the conventions set forth in [How to Program Racket](http://docs.racket-lang.org/style/index.html).
35
15
36
16
### Dependencies
37
-
Try to avoid external dependencies.
38
-
39
-
### Creating the description file
40
-
41
-
`README.md` may be [generated](https://github.com/exercism/docs/blob/master/maintaining-a-track/regenerating-exercise-readmes.md) from exercism data. The generator will use the `description.md` from the exercise directory in the [problem-specifications repository](https://github.com/exercism/problem-specifications/tree/master/exercises). To generate `README.md` for your execise only use the following command from your racket track directory:
42
-
43
-
```bash
44
-
bin/configlet generate . --only <exercise-name>
45
-
```
46
17
47
-
### Adding the exercise to config.json
48
-
Be sure to add the exercise to an appropriate place in the `config.json` file. The position in the file determines the order exercises are fetched by users. Generate a unique UUID for the exercise with ```configlet uuid```. Finally check `config.json` with:
49
-
50
-
```bash
51
-
bin/configlet lint .
52
-
```
18
+
Try to avoid external dependencies.
53
19
54
-
## Opening an Issue
20
+
## Suuport
55
21
56
-
If you plan to make significant or breaking changes, please open an issue so we can discuss it first. If this is a discussion that is relevant to more than just the Racket track, please open an issue in [exercism/discussions](https://github.com/exercism/discussions/issues).
22
+
For support with Racket in Exercism, please visit [the Racket subcategory](https://forum.exercism.org/c/programming/racket/) on the official [Exercism forum](https://forum.exercism.org).
57
23
58
24
## Submitting a Pull Request
59
25
60
-
Pull requests should be focused on a single exercise, issue, or conceptually cohesive change. Please refer to Exercism's [pull request guidelines](https://github.com/exercism/docs/blob/master/contributing/pull-request-guidelines.md).
26
+
Pull requests should be focused on a single exercise, issue, or conceptually cohesive change. Please refer to Exercism's [pull request guidelines](https://github.com/exercism/docs/blob/master/contributing/pull-request-guidelines.md). If you plan to make significant or breaking changes, please open an issue so we can discuss it first.
61
27
62
28
Prior to submitting a pull request, ensure that your test requires the stub file, and not the example file - like so:
63
29
@@ -81,5 +47,6 @@ Prior to submitting a pull request, ensure that your test requires the stub file
81
47
```
82
48
83
49
## Racket icon
50
+
84
51
The Racket logo was created by [Matthew Butterick](https://en.wikipedia.org/wiki/Matthew_Butterick) and released under the Creative Commons Attribution-Share Alike 3.0 Unported license.
85
52
We have adapted it, changing the colour scheme for use on Exercism.
0 commit comments