Skip to content

Commit f3a5b6a

Browse files
Clarify first time action setup (#51)
* Clarify first time action setup * Tweak readme further --------- Co-authored-by: Davis Vaughan <davis@posit.co>
1 parent cf39057 commit f3a5b6a

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ usethis::use_github_action(url = "https://github.com/posit-dev/setup-air/blob/ma
4545
This action runs `air format .` on every pull request.
4646
If formatting is required, the check fails and suggestion comments are added directly to the pull request.
4747
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.
48-
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.
48+
49+
Note that suggestion comments only appear on files that have changed in the pull request. Because of this, 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 before using this action.
4950

5051
This action is great for managing pull requests from external contributors.
5152
Even if they don't use Air themselves, they can commit the suggestions to pass Air's formatting checks.

0 commit comments

Comments
 (0)