Skip to content

Commit b930d1f

Browse files
committed
docs: document lychee and academy testing
1 parent efc3099 commit b930d1f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,12 @@ Add languages by adding new folders at the appropriate path level.
335335
- Run `vale sync` to download styles
336336
- Configure exceptions in `accepts.txt`
337337

338+
### Testing
339+
340+
- **Broken links**: [Periodic GitHub Action](.github/workflows/lychee.yml) checks broken links by [lychee](https://lychee.cli.rs/). If the Action fails, we manually fix the issues.
341+
342+
- **Academy exercises**: At the end of each lesson in the academy courses, there are exercises that target real-world websites. Each exercise includes a solution, stored as a separate file containing executable code. These files are included in the docs using the `!!raw-loader` syntax. Each course has a [Bats](https://bats-core.readthedocs.io/) test file named `test.bats`. The tests run each solution as a standalone program and verify that it produces output matching the expected results. A [periodic GitHub Action](.github/workflows/test-academy.yml) runs all these tests using `npm run test:academy`. If the Action fails, we rework the exercises.
343+
338344
## Pull request process
339345

340346
1. Follow [Conventional Commits](https://www.conventionalcommits.org/)

0 commit comments

Comments
 (0)