Add comments

Author: james-toussaint

.github/workflows/coverage.yml

@@ -1,7 +1,6 @@
 on:
   pull_request:
     branches:
-      - feature/* # TODO: Remove it
       - develop
       - main
 
@@ -17,7 +16,7 @@ jobs:
         run: (npm run coverage 2>&1) | tee /tmp/coverage.out | cat
       - name: Extract coverage
         run: echo "COVERAGE=$(cat /tmp/coverage.out | grep "Global test coverage")" >> $GITHUB_ENV
-      - name: Create coverage check run # Publish coverage summary to Github PR checks
+      - name: Display coverage in Github PR checks
         # See https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
         # and https://www.kenmuse.com/blog/creating-github-checks/
         env:

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## vNext
+- Display coverage in Github PR checks. (#26)
 - Add integration test suite. (#21)
 - Add unit test suite. (#20)
 

README.md

@@ -4,6 +4,16 @@ A subgraph to explore the PoCo smarcontracts
 
 [CHANGELOG](./CHANGELOG.md)
 
+# Setup coverage⁠
+
+> In order for Matchstick to check which handlers are being run, those handlers need to be exported from the test file.
+
+Check how to export handlers with [Matchstick - Test Coverage documentation](https://thegraph.com/docs/en/subgraphs/developing/creating/unit-testing-framework/#test-coverage).
+
+> [!NOTE]
+> Since Matchstick code coverage is in very early stages, Matchstick cannot check for branch coverage, but rely on the assertion that a given handler has been called.
+
+
 ## local dev
 
 run local services: