Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 3.52 KB

TRACK_README.md

File metadata and controls

67 lines (39 loc) · 3.52 KB

Exercism {{LANGUAGE}} Track

build status

Exercism exercises in {{LANGUAGE}}.

Setup

The simplest way to install {{LANGUAGE}} is ...

Contributing

Thank you so much for contributing! 🎉

Please read about how to get involved in a track. Be sure to read the Exercism Code of Conduct.

We welcome pull requests of all kinds. No contribution is too small.

We encourage contributions that provide fixes and improvements to existing exercises. Please note that this track's exercises must conform to the Exercism-wide standards described in the documentation. If you're unsure about how to make a change, then go ahead and open a GitHub issue, and we'll discuss it.

Exercise Tests

At the most basic level, Exercism is all about the tests. You can read more about how we think about test suites in the Exercism documentation.

Test files should use the following format:

# include the body of an example test

Opening an Issue

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 {{LANGUAGE}} track, please open an issue in exercism/discussions.

Submitting a Pull Request

Pull requests should be focused on a single exercise, issue, or conceptually cohesive change. Please refer to Exercism's pull request guidelines.

Please follow the coding standards for {{LANGUAGE}}. (If there is a formatter for the track's language, add instructions for using it here.)

Verifying Your Change

Before submitting your pull request, you'll want to verify the changes in two ways:

  • Run all the tests for the {{LANGUAGE}} exercises
  • Run an Exercism-specific linter to verify the track

All the tests for {{LANGUAGE}} exercises can be run from the top level of the repo with

# add this command

For the Exercism-specific linting, please see the documentation.

Contributing a New Exercise

Please see the documentation about adding new exercises.

Note that:

  • Each exercise must stand on its own. Do not reference files outside the exercise directory. They will not be included when the user fetches the exercise.
  • Exercises should use only the {{LANGUAGE}} core libraries.
  • Exercises must conform to the Exercism-wide standards described in the documentation.
  • Each exercise should have a test suite, an example solution, a template file for the real implementation and ... (anything else that needs to go with each exercise for this track). The CI build expects files to be named using the following convention: (describe the {{LANGUAGE}} convention for naming the various files that make up an exercise).
  • Please do not commit any configuration files or directories inside the exercise other than ...
  • Be sure to add it to the appropriate place in the config.json file.