Skip to content

Confusing README for first time setup #50

@lbm364dl

Description

@lbm364dl

I tried to use the action and I initially failed. This was my reasoning:

  1. I was reading the README from here and I saw this part:

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.

  1. I ran air format . locally, and I saw that in fact it detected not too many changes, so I felt the above clarification was unnecessary in my case and I could handle this directly through committing the bot suggestions in the PR.
  2. I created a PR expecting to see the bot suggestions but the format-suggest.yaml workflow ended correctly and nothing showed up.
  3. I tried to push a dummy change and in this case the suggestion did show up, but only for this small change.
  4. I realised the suggestions only appear for code that was changed in that same PR, not all the code. I don't know how the action really works so I can't tell if this is just a default, but it was confusing for me.

Leaving this here in case this happens to someone else.
Also my attempts through the steps above if it helps eduaguilera/whep#49.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions