Update PR workflow / workspace

[Archmonger]

_{This contribution is made under the MIT license.}

Issues

N/A

Summary

• Add VS Code extension suggestions
• Reorganize pull request template

Checklist

• Tests have been included for all bug fixes or added functionality.
• The changelog.rst has been updated with any significant changes.

[Archmonger]

@rmorshea Can you send me your ruff vscode config? I can't seem to get it to not auto format everything in an extremely annoying way in my environment

[rmorshea]

will send the ruff config tomorrow

[rmorshea]

It seems like there's not a whole lot special about my config. I just have the charliemarsh.ruff extension installed and the following:

project:

{
  "python.formatting.provider": "none",
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }
}

user:

  "python.languageServer": "Pylance",
  "python.analysis.autoImportCompletions": true,
  "python.formatting.provider": "black",
  "[python]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll": true
    },
    "editor.formatOnType": true
  },

It's possible that our Ruff config in pyproject.toml could use some refinement. For example, Ruff aggressively removes unused code which, if you save while you're working on something, can be annoying.

[Archmonger]

Tests are borked again, preventing merge.

[Archmonger]

I can't self-merge on this repo so I will need another approval.

[rmorshea]

This is already the default

[Archmonger]

Setting python.languageServer and python.liniting.enabled allows for VS Code to warn the user if it's not installed.

[rmorshea]

Not sure why we need to configure this.

[Archmonger]

Without customizing this, sometimes VS Code will try to use tabs instead of spaces depending on the file type.

[rmorshea]

This is already the default except on VSCode insiders

[Archmonger]

Should we keep it off in anticipation of the insiders build coming to main?

[rmorshea]

I use all the defaults for Prettier. I also think it will auto detect project configuration by looking for one of the places it might be set: https://prettier.io/docs/en/configuration.html

[Archmonger]

Without proseWrap and endOfLine, prettier will auto-format jinja templates in a way that breaks them.

[Archmonger]

Let me know if you agree/disagree with the open comments.

[Archmonger]

I can't merge due to lint errors.

[Archmonger]

I'm realizing it's going to get annoying to maintain a vscode config file. Microsoft tends to deprecate/delete settings very frequently, and I don't want us to deal with that.

I've changed this PR to only have suggested workspace extensions.