From ed866fb70218cfb015384dfcc470e2a4f9b2c8a9 Mon Sep 17 00:00:00 2001 From: Catalin Covaci <58592115+lbm364dl@users.noreply.github.com> Date: Fri, 1 Aug 2025 13:41:23 +0200 Subject: [PATCH] Clarify first time action setup --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6db7d80..769a61d 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,9 @@ usethis::use_github_action(url = "https://github.com/posit-dev/setup-air/blob/ma This action runs `air format .` on every pull request. If formatting is required, the check fails and suggestion comments are added directly to the pull request. We recommend committing the suggestions in a single batch from the `Files changed` view, which will trigger a rerun of the check and delete the outdated suggestion comments. -Before using this action, ensure that you've locally run Air on your entire project at least once using `air format .` or the `Air: Format Workspace Folder` command in VS Code or Positron, otherwise you can end up with a very large amount of suggestions. + +Before using this action, ensure that you've locally run Air on your entire project at least once using `air format .` or the `Air: Format Workspace Folder` command in VS Code or Positron. +The suggestion comments only consider code that you have changed yourself in the pull request, so you wouldn't see comments for your whole code. This action is great for managing pull requests from external contributors. Even if they don't use Air themselves, they can commit the suggestions to pass Air's formatting checks.