From f50a9dcda46e32809f7d6d6f7243587b54f3cac1 Mon Sep 17 00:00:00 2001 From: Karol Sewilo Date: Wed, 4 Dec 2024 12:49:36 +0100 Subject: [PATCH] Documentation commit-id:e51ac6f7 --- CHANGELOG.md | 6 ++++++ README.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index af4c8d0..edb68f8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +#### Added + +- `.cairo-coverage-ignore` file to exclude files or directories from the coverage report + ## [0.3.0-rc0] - 2024-11-21 #### Fixed diff --git a/README.md b/README.md index f4fa846..f56ee41 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,12 @@ curl -L https://raw.githubusercontent.com/software-mansion/cairo-coverage/main/s ## Usage +### `.cairo-coverage-ignore` File + +You can create a `.cairo-coverage-ignore` file in the root of your project to specify the files or directories that you +want to exclude from the coverage report. The file should contain a list of paths to be ignored, with one path per line, +similar to a `.gitignore` file. + ### Generate Coverage Report To generate a coverage report, run the `cairo-coverage` command with one or more `` arguments. These