Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
grodowski authored Jan 23, 2024
1 parent c97f595 commit 587921b
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 587921b

Please sign in to comment.