From e73526d227273005b776b3f522838936a969a184 Mon Sep 17 00:00:00 2001
From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com>
Date: Wed, 11 Dec 2024 18:32:21 +0100
Subject: [PATCH] docs: document the required permissions for the GitHub token
 (#222)

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index c2e9497..11f7ffe 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,8 @@ jobs:
   lint-pr:
     name: Lint pull request title
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # post comments when 'comment' is true
     steps:
       - name: Lint pull request title
         uses: jef/conventional-commits-pr-action@v1
@@ -41,6 +43,8 @@ jobs:
 | Default value | `true` |
 |---------------|--------|
 
+**Note**: commenting in the pull request conversation requires that the token is configured with the `pull-requests` permission.
+
 ### `token`
 
 **Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.