-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Description
Is your feature request related to a use case or problem? Please describe.
To help developers more easily write code that fits the project coding style, and to reduce time spent correcting formatting discrepancies that get flagged by code checkers, we should probably add a .editorconfig
file.
Describe the solution you'd like
Create a .editorconfig
file at the project top level, and set it up to match what is required by check/all
.
[optional] Describe alternatives/workarounds you've considered
We could point people to a style guideline document and let them take care of setting things up themselves. This is more flexible but less efficient and effective than providing a configuration file.
What is the urgency from your perspective for this issue? Is it blocking important work?
P2 - we should do it in the next couple of quarters
We are already having cases of discrepancies between people's editors and what the Black-based formatting checks in Cirq complain about, so this is a real need.