sztheory/tcl

Exercism Tcl Track

Exercism exercises in Tcl.

Setup

Tcl installation is described in the INSTALLATION document.

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 (see below) 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.

Tcl test files use the tcltest core package. Here are two excellent introductory overviews:

• Getting started with tcltest
• Getting Started with tcltest (goes more in-depth)

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 Tcl 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 Tcl. (TODO: reference one...)

Verifying Your Change

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

• Run all the tests for the Tcl exercises
• Run an Exercism-specific linter to verify the track

All the tests for Tcl exercises can be run from the top level of the repo with

$ bin/check_exercise_versions
# ensure you have committed your code before running the following:
$ bin/test_all_exercises

Note that the test_all_exercises script will overwrite the "slug".tcl and then check it out again from git when the test is complete. If you have not committed your code, you risk losing that template file.

To run the linter, use the configlet tool:

$ path/to/configlet lint .

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 Tcl core libraries.

• Exercises must conform to the Exercism-wide standards described in the documentation.

• Each exercise should have a test suite, an example solution and a template file for the real implementation. Use the canonical-data.json file for the exercise from the problem-specifications repo to guide your test implementation.

• The CI build expects files to be named using the following convention:

    exercises/
    └── hello-world/            # (dir name == "slug" name)
        ├── .meta
        │   ├── hints.md        # (optional)
        │   └── version         # (required)
        ├── example.tcl
        ├── hello-world.tcl     # "slug".tcl
        ├── hello-world.test    # "slug".test
        └── README.md           # (generated)
  

• use configlet generate . --only $slug to generate the README file. The contents of .meta/hints.md will be incorporated into the README if you need to add Tcl-specific information.

• Please do not commit any configuration files or directories inside the exercise.

• Be sure to reference the new exercise at the appropriate place in the config.json file.

  • Core exercises are placed at the top of the config file, in the order we want them to occur.
  • Side exercises (that are unlocked when a core exercise is completed) are placed below, grouped and ordered by their parent core exercise.