OSDN Git Service

[fix] : Fixed code
authorhayao <shun819.mail@gmail.com>
Mon, 18 May 2020 01:19:09 +0000 (10:19 +0900)
committerhayao <shun819.mail@gmail.com>
Mon, 18 May 2020 01:19:09 +0000 (10:19 +0900)
docs/CONTRIBUTING.md

index 0ccb27d..ba39370 100644 (file)
@@ -4,15 +4,15 @@
 
 ### 全体
 - なるべく`bash`のビルドインコマンドを使用する
-- 外部コマンドを使用する場合は依存パッケージを追加する
+- 外部コマンドを使用する場合は依存パッケージを追加する(極力使用しない)
 
-#### 出力
+### 出力
 - エラーメッセージは全て`STDERR`に出力する
 - メッセージ用の関数がある場合はその関数を使用する
 - 最小限の出力とし、冗長な出力は引数で有効化された場合のみに許可する
 
 ### 見た目
-- インデントはスペース4とする
+- ã\82¤ã\83³ã\83\87ã\83³ã\83\88ã\81¯ã\82¹ã\83\9aã\83¼ã\82¹4ã\81¤ã\81¨ã\81\99ã\82\8b
 - 引数の多いコマンド(`xorriso`など)やパイプを多用する場合は`\`で改行する
 - コードにTodoを書く場合は日付とユーザー名を書く
 
 ### if、for、test、case、while
 - `test`コマンドは必ず`[[`を使用する
 - `do`や`then`などは`while`、`for`、`if`と同じ行に書く
-```bash
-# Bad
-if [[ "${var}" = "hoge" ]]; then
-    echo "HogeHoge"
-fi
+- `case`の際はなるべくインデントを揃える
 
-# Good
-[[ "${var}" = "hoge" ]] && echo "HogeHoge"
+### 例
+```bash
+# Usage: test_hoge <str>
+test_hoge () {
+    local _var="${1}"
+    if [[ "${var}" = "hoge" ]]; then
+        echo "${var} is hoge"
+        return 0
+    else
+        echo "${var} is not hoge"
+        return 1
+    fi
+}
 ```
-- `case`の際はなるべくインデントを揃えて下さい
 
 
 ### その他