From 2972f9ed337da59ad743d9d8e18230a81385c665 Mon Sep 17 00:00:00 2001 From: Yury Bayda Date: Sun, 2 Aug 2026 21:21:02 -0700 Subject: [PATCH] ci: align Markdown documentation --- .github/workflows/main.yml | 5 +++++ .markdownlint.json | 8 ++++++++ README.md | 22 +++++++++++++++++++++- 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 .markdownlint.json diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f4a77e1..4644b97 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,11 @@ jobs: steps: - uses: actions/checkout@v7 + - name: Lint Markdown + uses: DavidAnson/markdownlint-cli2-action@v23 + with: + globs: "**/*.md" + - name: Check formatting run: make format-check diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2bf8ad4 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "MD013": { + "line_length": 100 + }, + "MD024": { + "siblings_only": true + } +} diff --git a/README.md b/README.md index a2e9747..e41bcde 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Tennis C++ Kata +# Tennis kata in C++ [![CI](https://github.com/Coding-Cuddles/tennis-cpp-kata/actions/workflows/main.yml/badge.svg)](https://github.com/Coding-Cuddles/tennis-cpp-kata/actions/workflows/main.yml) [![C++17](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://en.cppreference.com/w/cpp/17) @@ -110,6 +110,26 @@ and run the setup commands again. Setup is complete when the build succeeds and CTest discovers the disabled test. +## Work on the kata + +1. Remove the `DISABLED_` prefix from the test in `test_tennis.cpp`, then + implement the scoring behavior in `tennis.h`. + +2. Run the tests after each change. Use Make when it is installed: + + ```console + make test + ``` + + Otherwise, use CMake and CTest directly: + + ```console + cmake --build build --config Debug + ctest --test-dir build --build-config Debug --output-on-failure + ``` + + Continue when CTest reports `100% tests passed`. + ## Make command reference Make is optional. Run `make` or `make help` to list these commands in the