Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[global] PR Template: Add section about linting #4874

Open
schnatterer opened this issue Sep 26, 2024 · 0 comments
Open

[global] PR Template: Add section about linting #4874

schnatterer opened this issue Sep 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@schnatterer
Copy link
Contributor

Is your feature request related to a problem ?

For me as a contributor, the process of linting is dragging on, because

  • I have to wait for a maintainer to start the process.
  • Then I might have fixed only 9 out of 10 findings
  • So I wait again for a maintainer to start the process.
  • Then a different linter tells me other findings. So I fix them.
  • I wait again for a maintainer to start the process.

Describe the solution you'd like.

A simple solution would be to mention linting in the Pull Request template.
It could link to a document that tells me what linters are running and how I can run them locally.
I would prefer docker run commands for the linters as they run on all dev machines without prior setup and are deterministic.

Describe alternatives you've considered.

I'm sure there could be other options, like automatically run linters on commit.

Additional context.

FTR I discovered this behavior while working on #4818

@schnatterer schnatterer added the enhancement New feature or request label Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant