f4pga / f4pga/ideas

Add an .editorconfig file to all SymbiFlow repositories

Open
#50 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
86
Forks
9
PR merge metrics
No merged PRs in 30d

Description

[`.editorconfig` is a file](https://editorconfig.org/) which tells many editors how to set up their auto formatting configurations. See this example in the Yosys repository -> https://github.com/YosysHQ/yosys/blob/master/.editorconfig

We should create an `.editorconfig` for SymbiFlow projects and then add it to all our repositories.

We probably need a configurations for;
- [ ] Python files
- [ ] C++ files
- [ ] TCL scripts
- [ ] Bash scripts
- [ ] Makefiles
- [ ] cmake files
- [ ] Verilog files
- [ ] Exclude `third_party` directory

For Python files, it should match what `.yapf` settings we are using.
For C++ files it should match the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
For Verilog files it should match the [LowRISC Verilog Style Guide](https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md).

What else have I missed?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.