chore: Sync exercise documentation via configlet #856
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 21 commits
April 28, 2025 08:37
Refactored the instructions for clarity and conciseness. Reworded sentences to improve readability, removed redundancies, and ensured consistency in terminology.
Corrected the capitalization of "Atbash" to align with proper noun usage. This improves clarity and ensures consistency in the documentation.
Simplified the instructions to enhance readability. Improved example formatting and adjusted phrasing for better consistency and understanding. Removed unnecessary edge case prompts.
Condense the explanation and examples into a single concise sentence. This improves readability and removes redundant details while preserving the core instruction."
Expanded the instructions to include comprehensive descriptions of complex number properties and operations, such as conjugate, absolute value, addition, subtraction, multiplication, division, and exponentiation. Also laid out the implementation expectations clearly, specifying that built-in complex number support should not be used.
Reworded the instructions for improved readability and clarity. Broke down the description into concise sentences for easier understanding of the domino chain rules.
Refined the description to specify handling of nested arrays of any depth. Clarified treatment of null-like values and included a more comprehensive example to align with varying language tracks.
Refine phrasing to improve readability and fix minor grammatical issues in the instructions. Changes include better sentence structure, corrected punctuation, and consistent formatting for examples. These adjustments enhance comprehension while keeping the content precise and professional.
Streamlined the problem description for clarity and conciseness. Replaced the narrative with a straightforward explanation of the chessboard grain-doubling concept and adjusted the tasks accordingly.
Removed extraneous context about DNA replication and cell division to focus solely on calculating the Hamming distance. This improves clarity and keeps the instructions concise and relevant.
Provide clearer explanations for validating numbers using the Luhn algorithm. Refine examples with improved formatting, additional context, and concise steps for both valid and invalid cases.
Corrected the number of week values listed in the instructions to ensure accuracy. This change improves clarity and aligns the documentation with the problem requirements.
Adjusted the wording in the instructions to make them more concise, removing "user-entered" for clarity. This improves readability without changing the intended meaning.
Replaced "polypeptide" with "protein" and standardized language for consistency. Adjusted capitalization of "amino acids" and updated table column header for accuracy.
Updated the title in the Pythagorean triplet exercise documentation for better clarity and consistency with naming conventions. This change improves readability and aligns terminology with project standards.
Correct missing conjunctions and punctuation in the RNA transcription exercise instructions. These changes enhance readability and maintain consistency in formatting.
Added arrows and brackets to improve readability of the example grid, making it easier to identify the candidate treehouse location. This enhances comprehension for users working on the exercise.
Refined explanation of the Sieve of Eratosthenes for better readability and accuracy. Added detailed steps, examples, and visuals to make the process easier to follow, highlighting primes and marked numbers. Improved notes to emphasize algorithm implementation details.
Updated the usage of "Caesar Cipher" to "Caesar cipher" for consistent capitalization throughout the instructions. This improves readability and maintains uniform naming conventions.
Updated the instructions to specify that sublists and superlists must consist of contiguous sub-sequences. This improves clarity and aligns with the intended problem definition.
Corrected "lookup" to "look up" for grammatical accuracy. Ensures the documentation maintains a professional and polished standard.
|
Hello 👋 Thanks for your PR. This repo does not currently have dedicated maintainers. Our cross-track maintainers team will attempt to review and merge your PR, but it will likely take longer for your PR to be reviewed. If you enjoy contributing to Exercism and have a track-record of doing so successfully, you might like to become an Exercism maintainer for this track. Please feel free to ask any questions, or chat to us about anything to do with this PR or the reviewing process on the Exercism forum. (cc @exercism/cross-track-maintainers) |
Closed
added 7 commits
May 14, 2025 18:49
Introduced a Bash script `bin/add-practice-exercise` to streamline the creation of new practice exercises. It generates necessary files, enforces required configurations, and provides detailed next steps for implementation.
This commit introduces the "Bottle Song" exercise with its metadata, including slug, name, UUID, difficulty, and associated topics. It will help expand the curriculum and provide coverage for algorithms, control flow, strings, and text formatting.
Introduced a build.sbt file specifying Scala 3.4.2 as the version and adding Scalatest 3.2.19 as a test dependency. This sets up the project structure for the Bottle Song exercise.
Introduces a suite of tests to verify the behavior of the `BottleSong.recite` method. Covers various scenarios, including single verse, multiple verses, and the entire song. Ensures correctness of all expected outputs.
Introduce the BottleSong exercise to the practice track. Includes the `BottleSong.scala` implementation file and a metadata `tests.toml` file with test case descriptions.
Provide detailed lyrics for the "Ten Green Bottles" song to guide users in implementing the exercise. Clarifies variations between verses for accurate completion.
Introduce a `config.json` file for the 'Bottle Song' exercise, detailing authorship, relevant file structure, and a brief summary. This ensures proper organization and integration of the exercise into the practice track.
Added the `pending` marker to all test cases in `BottleSongTest`. This indicates that these tests are currently incomplete or temporarily disabled and require further implementation or adjustments.
|
If you sync the metadata as well, I can close #850 |
added 3 commits
May 14, 2025 21:35
The "topics" field was removed as it is no longer being utilized, simplifying the configuration. This change helps reduce redundancy and keeps the file cleaner and easier to maintain.
The add-practice-exercise script was no longer in use and has been removed to clean up the codebase. This helps reduce clutter and maintain project organization.
Upgraded the runner from Ubuntu 20.04 to Ubuntu 22.04 in the CI workflow file. This ensures compatibility with the latest software and security updates while aligning with long-term support for the runner.
Merged
added 23 commits
May 16, 2025 12:14
Refactored the instructions for clarity and conciseness. Reworded sentences to improve readability, removed redundancies, and ensured consistency in terminology.
Corrected the capitalization of "Atbash" to align with proper noun usage. This improves clarity and ensures consistency in the documentation.
Simplified the instructions to enhance readability. Improved example formatting and adjusted phrasing for better consistency and understanding. Removed unnecessary edge case prompts.
Condense the explanation and examples into a single concise sentence. This improves readability and removes redundant details while preserving the core instruction."
Expanded the instructions to include comprehensive descriptions of complex number properties and operations, such as conjugate, absolute value, addition, subtraction, multiplication, division, and exponentiation. Also laid out the implementation expectations clearly, specifying that built-in complex number support should not be used.
Reworded the instructions for improved readability and clarity. Broke down the description into concise sentences for easier understanding of the domino chain rules.
Refined the description to specify handling of nested arrays of any depth. Clarified treatment of null-like values and included a more comprehensive example to align with varying language tracks.
Refine phrasing to improve readability and fix minor grammatical issues in the instructions. Changes include better sentence structure, corrected punctuation, and consistent formatting for examples. These adjustments enhance comprehension while keeping the content precise and professional.
Streamlined the problem description for clarity and conciseness. Replaced the narrative with a straightforward explanation of the chessboard grain-doubling concept and adjusted the tasks accordingly.
Removed extraneous context about DNA replication and cell division to focus solely on calculating the Hamming distance. This improves clarity and keeps the instructions concise and relevant.
Provide clearer explanations for validating numbers using the Luhn algorithm. Refine examples with improved formatting, additional context, and concise steps for both valid and invalid cases.
Corrected the number of week values listed in the instructions to ensure accuracy. This change improves clarity and aligns the documentation with the problem requirements.
Adjusted the wording in the instructions to make them more concise, removing "user-entered" for clarity. This improves readability without changing the intended meaning.
Replaced "polypeptide" with "protein" and standardized language for consistency. Adjusted capitalization of "amino acids" and updated table column header for accuracy.
Updated the title in the Pythagorean triplet exercise documentation for better clarity and consistency with naming conventions. This change improves readability and aligns terminology with project standards.
Correct missing conjunctions and punctuation in the RNA transcription exercise instructions. These changes enhance readability and maintain consistency in formatting.
Added arrows and brackets to improve readability of the example grid, making it easier to identify the candidate treehouse location. This enhances comprehension for users working on the exercise.
Refined explanation of the Sieve of Eratosthenes for better readability and accuracy. Added detailed steps, examples, and visuals to make the process easier to follow, highlighting primes and marked numbers. Improved notes to emphasize algorithm implementation details.
Updated the usage of "Caesar Cipher" to "Caesar cipher" for consistent capitalization throughout the instructions. This improves readability and maintains uniform naming conventions.
Updated the instructions to specify that sublists and superlists must consist of contiguous sub-sequences. This improves clarity and aligns with the intended problem definition.
Corrected "lookup" to "look up" for grammatical accuracy. Ensures the documentation maintains a professional and polished standard.
Standardize wording in blurbs for clarity and precision, update source URLs to use web archives where needed, and refine source information for consistency. These changes ensure better readability and resilience of references.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation (instructions and introductions) for 21 Practice Exercises in the Scala track to bring them in sync with the central problem-specifications repository.
The updates were automatically generated by running the following command:
This addressed synchronization warnings for the following exercises:
This ensures that learners on the Scala track receive the latest, standardized documentation for these exercises. No manual changes were made beyond running the sync command.