Skip to content
This repository was archived by the owner on Jan 14, 2026. It is now read-only.

Commit 53f0979

Browse files
authored
Revise contributing guidelines for code standards
1 parent b326c94 commit 53f0979

1 file changed

Lines changed: 10 additions & 21 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ LiteCore Kernelをコーディングする際に、できるだけ守ってほ
33

44
### 基本
55
#### インデントは8です。
6-
4じゃないと見づらい、という人がいるかもしれませんが、それはコードの問題です。私の思う限り、インデントはコードブロックを見やすくするためのものなはずです。インデントが多くて見づらいコードは、つまりブロックが多すぎます。減らしましょう。折返しがされないくらいが程よいと思います。
6+
4じゃないと見づらい、という人がいるかもしれませんが、それはコードの問題です。私の思う限り、インデントはコードブロックを見やすくするためのものなはずです。インデントが多くて見づらいコードは、つまり入れ子となっているブロックが多すぎます。減らしましょう。折返しがされないくらいが程よいと思います。
77

88
#### コメントは日本語か英語で書いてください
99
私は日本語話者ですが、英語でのコメントも良いと思います。ただし、一つのファイル内では統合してください。
@@ -43,7 +43,7 @@ int load_config(void);
4343
const char* get_config_value(const char* key);
4444
void build_compile_command(void);
4545
```
46-
Rustのようにかっこよさを求める必要はありません。質
46+
どこぞのモダン言語のようにかっこよさを求める必要はありません
4747
4848
#### 定数(#define)は UPPER_SNAKE_CASE を使用してください
4949
```c
@@ -89,7 +89,7 @@ if (value == NULL) {
8989
### コメント
9090

9191
#### Doxygenコメント
92-
各ファイル、関数、定数、構造体にはDoxygenコメントをつけてください
92+
最低限、関数/定数/構造体にはドキュメントコメントをつけてください
9393

9494
#### その他のコメント
9595
コメントを書くのはとてもいいことですが、書きすぎないでください。
@@ -117,26 +117,17 @@ char files[MAX_FILES][256]; // サイズが明確
117117

118118
#### ヘッダーファイルにはインクルードガードを使用してください
119119
```c
120-
#ifndef LITECORE_CONFIG_H
121-
#define LITECORE_CONFIG_H
120+
#ifndef _CONFIG_H
121+
#define _CONFIG_H
122122

123123
// 宣言...
124124

125-
#endif /* LITECORE_CONFIG_H */
126-
```
127-
128-
#### 各ファイルの先頭にはファイルの説明を書いてください
129-
```c
130-
/**
131-
* @file config.c
132-
* @brief 設定ファイルの読み込み機能
133-
* @details .configファイルを解析してビルド設定を取得します
134-
*/
125+
#endif /* _CONFIG_H */
135126
```
136127

137128
### 関数の設計
138129

139-
#### 関数は一つのことだけを行うようにしてください
130+
#### 関数は一つのことだけを行うようにしてください(ただし、それらを行うことでわかりやすくなる場合は別です)
140131
```c
141132
// 良い例:単一責任
142133
int count_c_files(const char* dir_path);
@@ -146,7 +137,7 @@ int load_file_list(const char* dir_path, char files[][256]);
146137
int count_and_load_files(const char* dir_path, char files[][256]);
147138
```
148139
149-
#### 関数の引数は5個以下にしてください
140+
#### 関数の引数は可能な限り少なくしてください
150141
引数が多い場合は、構造体を使用することを検討してください。
151142
152143
```c
@@ -162,9 +153,7 @@ void build_command(const build_config_t* config, char* command);
162153
```
163154

164155
### テストとデバッグ
165-
166-
#### デバッグ用のprintfは本番コードから削除してください
167-
デバッグが必要な場合は、`debug()`関数を使用してください
156+
テストはすべてinclude/tests/define.h, src/tests/run.cと既存のテストを読んで追加してください。ある程度のプログラマであれば、書き方がわかるはずです。
168157

169158
### コードレビュー
170159

@@ -178,4 +167,4 @@ void build_command(const build_config_t* config, char* command);
178167
あなたが夜寝て、スッキリした後にそのコードを見たとき、すぐに理解できるかどうかを考えてください。
179168

180169
## 最後に
181-
このガイドラインは絶対的なものではありません。プロジェクトの要求や状況に応じて、適切に判断して使用してください。重要なのは、一貫性とチーム全体での合意です
170+
このガイドラインは絶対的なものではありません。プロジェクトの要求や状況に応じて、適切に判断して使用してください。重要なのは、一貫性とコミュニティ全体での合意です

0 commit comments

Comments
 (0)