Skip to content

Commit 11c84ed

Browse files
authored
Update README (#284)
1 parent faed687 commit 11c84ed

File tree

1 file changed

+7
-40
lines changed

1 file changed

+7
-40
lines changed

README.md

+7-40
Original file line numberDiff line numberDiff line change
@@ -7,57 +7,23 @@ Exercism exercises in Racket.
77

88
## Contributing
99

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.
3211

3312
### Code Style
13+
3414
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).
3515

3616
### 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-
```
4617

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.
5319

54-
## Opening an Issue
20+
## Suuport
5521

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).
5723

5824
## Submitting a Pull Request
5925

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.
6127

6228
Prior to submitting a pull request, ensure that your test requires the stub file, and not the example file - like so:
6329

@@ -81,5 +47,6 @@ Prior to submitting a pull request, ensure that your test requires the stub file
8147
```
8248

8349
## Racket icon
50+
8451
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.
8552
We have adapted it, changing the colour scheme for use on Exercism.

0 commit comments

Comments
 (0)