From 587921b92ae1fc2c12a04c79e8a6c02bef5a7966 Mon Sep 17 00:00:00 2001 From: Jan Grodowski Date: Tue, 23 Jan 2024 09:21:16 +0100 Subject: [PATCH] Update README.md --- README.md | 27 ++++++--------------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7db80e4..c9a71be 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,9 @@ -# README +# undercover-test -This README would normally document whatever steps are necessary to get the -application up and running. +Demo Rails app with Undercover GitHub App configured to find untested methods, blocks and classes in each commit. -Things you may want to cover: +Check out the the [sample PR catching an untested and changed codepath](https://github.com/twitchy-tortoise/undercover-test/pull/57), [`test_helper.rb`](https://github.com/twitchy-tortoise/undercover-test/blob/master/test/test_helper.rb) and [GitHub Actions build config](https://github.com/twitchy-tortoise/undercover-test/blob/c97f59502b6aa20587c503bb051e78edab648802/.github/workflows/test.yml) or go straight to https://undercover-ci.com to get started! -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +Coming soon: +- view coverage (with `enable_coverage_for_eval`) +- in-app dashboard with charts (passed/failed checks over time, untested methods detected over time, and more)