How exercism/julia works
Main Components
• Exercism Track Repository – the central hub containing all configurations, documentation, and code used for the track.
• Exercises Module – contains two major types of exercises:
• “concept” exercises (focused on language or computational concepts)
• “practice” exercises (focused on algorithmic challenges)
Each exercise has its own subdirectory with tests, exercise implementations, metadata, and documentation.
• Concepts Repository – holds learning materials and explanations about various Julia topics (found in directories like “concepts” and “concepts.wip”). This module prepares content that can be referenced by the exercises.
• Generators Module – includes utilities and scripts (in the “generators” directory) that generate exercise skeletons, validate solutions, or help maintain consistency in the exercise files.
• CI/CD and Configuration – comprises GitHub workflows (in the “.github/workflows” directory), configuration files (such as “Project.toml”, “config.json”, “runtests.jl”), and other files like “CONTRIBUTING.md” and “CODE_OF_CONDUCT.md” that help enforce quality and process guidelines.
• Reference Documentation – contains documentation about exercise concepts, transitions, and implementation guidelines (directories like “docs” and “reference”).
Relationships and Interactions
• The core Exercism Track Repository acts as the integration point where exercises are created, tested, and managed. It feeds content into the Exercism platform.
• The Exercises and Concepts modules are interrelated, where exercises often refer to or are designed around core concepts.
• The Generators module interacts with both exercises and configuration templates to generate or update exercise files automatically.
• CI/CD pipelines (via GitHub workflows) continuously validate, test, and enforce formatting guidelines for changes across exercises, concepts, and generator scripts.
• Configuration files (e.g., “Project.toml”, “config.json”, “.github” files) provide build, dependency, and workflow management that links the entire repository together.
Architectural Patterns and Design Principles
• Separation of Concerns – There is a clear division between content (exercises and concept explanations), tooling (generators), and infrastructure (CI/CD configuration).
• File-based organization – The structure mainly relies on directory partitioning to segregate exercises, documentation, and tools.
• Reusability and automation – The use of generator scripts points to an emphasis on automation for consistency and the ability to regenerate exercise skeletons when needed.
Relevant Technologies, Frameworks, and Libraries
• The repository is written in Julia and adheres strictly to Julia’s code formatting guidelines (camel case for types, lower case for methods with underscores, etc.).
• Externally, it leverages GitHub Actions for CI/CD (via .github/workflows) and a tool called Configlet (indicated by badges in the README) to manage track configurations.
• Dependency management is handled through “Project.toml” and “Manifest.toml” files present in various parts (especially in the generators).