33## コーディング規約
44
55### 全体
6+
67- なるべく` bash ` のビルドインコマンドを使用する
78- 外部コマンドを使用する場合は依存パッケージを追加する(極力使用しないでください)
89
910### 出力
11+
1012- エラーメッセージは全て` STDERR ` に出力する
1113- メッセージ用の関数がある場合はその関数を使用する
1214- 最小限の出力とし、冗長な出力は引数で有効化された場合のみに許可する
1315
1416### 見た目
17+
1518- インデントはスペース4つとする
1619- 引数の多いコマンド(` xorriso ` など)やパイプを多用する場合は` \ ` で改行する
1720- コードにTodoを書く場合は日付とユーザー名を書く
1821
1922### 変数や関数
23+
2024- 全ての関数に概要や使い方にコメントを書く
2125- 関数の定義は` function ` を付けず、` my_func () {} ` を使用する
2226- 全ての変数は` ${hoge} ` のように括弧を使用する
2529- 算術式展開は` $(( m + n )) ` を使用する
2630
2731### if、for、test、case、while
32+
2833- ` test ` コマンドは必ず` [[ ` を使用する
2934- ` do ` や` then ` などは` while ` 、` for ` 、` if ` と同じ行に書く
3035- ` case ` の際はなるべくインデントを揃える
3136
3237### 例
38+
3339``` bash
3440# Usage: test_hoge <str>
3541test_hoge () {
@@ -44,21 +50,25 @@ test_hoge () {
4450}
4551```
4652
47-
4853### その他
54+
4955- 極力相対パスを使用しない
5056- ファイルパスは必ず` "" ` で囲む
5157
5258## Issues
59+
5360Issueを送る際は以下の情報を記述して下さい。
61+
5462- インストールに使用したイメージファイルへのURL
5563- 問題が発生した環境
5664- どのようなことを行ったか
5765- スクリーンショットやログ等
5866- ビルドに問題が発生した際は作業ディレクトリにある` build_options `
5967
6068## プルリクエスト
69+
6170日本語もしくは英語で内容を書いて下さい。内容とは具体的に以下のものを指します。
71+
6272- どのような機能を追加するか(問題を修正するのか)
6373- 現在確認されている問題(その対処方法も書ければ)
6474- 参考にした文献について
@@ -71,20 +81,24 @@ Issueを送る際は以下の情報を記述して下さい。
7181## Coding Conventions
7282
7383### General
84+
7485- Use the ` bash ` build-in command if possible
7586- Add a dependency package if you use an external command (please try not to use it as much as possible)
7687
7788### Output
89+
7890- Output all error messages to ` STDERR `
7991- If you have a function for messages, use that function
8092- Minimize output and redundant output only allow when enabled by the argument
8193
8294### Looks
95+
8396- Indent should be four spaces
84- - The line break with ` \ ` when use a lot of command with many arguments (` xorriso ` , etc.) or a lot of pipes
97+ - The line break with ` \ ` when using a lot of commands with many arguments (` xorriso ` , etc.) or a lot of pipes
8598- If you write a Todo in your code, write the date and user name
8699
87100### Variables and functions
101+
88102- Write comments on all functions in summary and usage
89103- The function definition does not use a ` function ` but uses ` my_func () {} `
90104- All variables use brackets like ` ${hoge} `
@@ -93,11 +107,13 @@ Issueを送る際は以下の情報を記述して下さい。
93107- Arithmetic expansion uses ` $(( m + n )) `
94108
95109### if, for, test, case, while
110+
96111- The ` test ` command must use ` [[ `
97112- ` do ` , ` then ` , etc. write on the same line as ` while ` , ` for ` and ` if `
98113- Align indents on ` cases ` as much as possible
99114
100115### Example
116+
101117``` bash
102118# Usage: test_hoge <str>
103119test_hoge () {
@@ -112,21 +128,25 @@ test_hoge () {
112128}
113129```
114130
115-
116131### Other
132+
117133- Use as few relative paths as possible.
118134- Make sure to enclose the file path in ` "" ` .
119135
120136## Issues
137+
121138When you send the issue, please include the following information.
139+
122140- The URL to the image file used for the installation
123141- The environment in which the problem occurred
124142- What did we do
125143- Screenshots, logs, etc.
126- - If a problem happen when you building, Please attach the file ` build_options ` in the working directory
144+ - If a problem happens when you're building, Please attach the file ` build_options ` in the working directory
127145
128146## Pull Request
147+
129148Please write content in either Japanese or English. Specifically, the content refers to the following
149+
130150- What features you are going to add (or fix the problem)
131151- Known issues (and how to deal with them if you can write about them)
132152- About the references
0 commit comments