Skip to content

Developer docs#11

Open
TheRealOwenRees wants to merge 11 commits intoexercism:mainfrom
TheRealOwenRees:developer-docs
Open

Developer docs#11
TheRealOwenRees wants to merge 11 commits intoexercism:mainfrom
TheRealOwenRees:developer-docs

Conversation

@TheRealOwenRees
Copy link
Copy Markdown
Contributor

first draft of updating the repository's readme for contributing to the ReScript language track

Now complete the following steps:

- `config.json` - ensure that the new exercise data is correctly placed in order of difficulty and then alphabetically within that difficulty rating.
- implement exercise test cases, detailed in the [testing](#testing) section below.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be clear here that they need to make a template file first for the test generator to run. They then need to run the generator, making sure it runs a compilable ReScriptTest suite. Tests may need to be excluded from the tests.toml as well so that should be done as well. However, test generator may need to be rerun after you start working on the example solution and find a test for make sense for ReScript. Therefore we should mention or link out about the toml and how to skip a test there.

Most of that is in the below section but it should be inlined here or introduced beforehand.

Perhaps we break this into task-related sections:

Generating Tests?

Do this...

Updating An Existing Exercise?

Do this...

Adding A New Exercise?

Do this...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latest commit is draft 1 of this section. Please review. It is likely rough around the edges. I have commented out the old version for now, for reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants