You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@teaclave.apache.org by Qinkun Bao <no...@github.com.INVALID> on 2022/02/04 07:29:50 UTC

[apache/incubator-teaclave] Add shell script style (Issue #612)

We should have a style guide for bash scripts.

As discussed in https://github.com/apache/incubator-teaclave/pull/609, environment variables and internal shell variables are capitalized. All other variable names should be lower case. Some shell scripts in the project don't follow this convection. 

Here is an example:
https://google.github.io/styleguide/shellguide.html

In addition, we can add a shell scripts format checker to the build pipeline.

-- 
Reply to this email directly or view it on GitHub:
https://github.com/apache/incubator-teaclave/issues/612
You are receiving this because you are subscribed to this thread.

Message ID: <ap...@github.com>

Re: [apache/incubator-teaclave] Add shell script style (Issue #612)

Posted by Mingshen Sun <no...@github.com.INVALID>.
Another useful tool `shfmt`: https://github.com/mvdan/sh

-- 
Reply to this email directly or view it on GitHub:
https://github.com/apache/incubator-teaclave/issues/612#issuecomment-1032965168
You are receiving this because you are subscribed to this thread.

Message ID: <ap...@github.com>

Re: [apache/incubator-teaclave] Add shell script style (Issue #612)

Posted by Mingshen Sun <no...@github.com.INVALID>.
The shellcheck will be helpful for the issue: https://github.com/koalaman/shellcheck

-- 
Reply to this email directly or view it on GitHub:
https://github.com/apache/incubator-teaclave/issues/612#issuecomment-1030254748
You are receiving this because you are subscribed to this thread.

Message ID: <ap...@github.com>