citusdata / citusdata/the-process

Build tooling around shfmt to enforce shell style

Open
#19 0 comments 0 reactions 0 assignees View on GitHub
Area :hammer_and_wrench: Effort :school_satchel: Type :sparkles:
Dominant language
Dockerfile
Stars
6
Forks
7
Avg merge
4d 22h
Merged PRs (30d)
1

Description

At the moment, we use `uncrustify` for C code, but other file types live in the wild west. Google's style guides include a [shell script entry](https://google.github.io/styleguide/shell.xml#Naming_Conventions), and in lieu of better alternatives we should consider adopting it (at least as a starting point).

The [`shfmt`](https://www.github.com/mvdan/sh) tool can help with this.

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.