Skip to content

Commit 2428a06

Browse files
authored
.editorconfig と .gitattributes を追加 (#103)
* .editorconfig を追加 * .editorconfig を編集 * .gitattributes を追加 * AGENTS.md に「Markdown の空白に関する方針」を追記 * AGENTS.md に追記 * リポジトリ固有のバイナリ拡張子を追加 * コメントを追加 * 修正 * 空白幅を調整 * 修正 * コメントを修正
1 parent fc0371c commit 2428a06

3 files changed

Lines changed: 92 additions & 1 deletion

File tree

.editorconfig

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
# Common binary files
13+
[*.{png,jpg,jpeg,gif,webp,ico,pdf,zip,gz,tar,7z,jar,war,class,exe,dll,so,dylib,woff,woff2,ttf,eot}]
14+
end_of_line = unset
15+
charset = unset
16+
trim_trailing_whitespace = unset
17+
insert_final_newline = unset
18+
19+
# Markdown
20+
[*.{md,mdx}]
21+
indent_size = 2
22+
trim_trailing_whitespace = false
23+
24+
# Generated C, C++ and Python binary files
25+
[*.{a,lib,o,obj,pyc,pyo,pyd}]
26+
end_of_line = unset
27+
charset = unset
28+
trim_trailing_whitespace = unset
29+
insert_final_newline = unset

.gitattributes

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
* text=auto eol=lf
2+
3+
# Common binary files
4+
*.png binary
5+
*.jpg binary
6+
*.jpeg binary
7+
*.gif binary
8+
*.webp binary
9+
*.ico binary
10+
*.pdf binary
11+
*.zip binary
12+
*.gz binary
13+
*.tar binary
14+
*.7z binary
15+
*.jar binary
16+
*.war binary
17+
*.class binary
18+
*.exe binary
19+
*.dll binary
20+
*.so binary
21+
*.dylib binary
22+
*.woff binary
23+
*.woff2 binary
24+
*.ttf binary
25+
*.eot binary
26+
27+
# Markdown
28+
*.md text diff=markdown whitespace=-blank-at-eol
29+
*.mdx text diff=markdown whitespace=-blank-at-eol
30+
31+
# C, C++
32+
*.c text diff=cpp
33+
*.cc text diff=cpp
34+
*.cpp text diff=cpp
35+
*.cxx text diff=cpp
36+
*.h text diff=cpp
37+
*.hh text diff=cpp
38+
*.hpp text diff=cpp
39+
*.hxx text diff=cpp
40+
*.ipp text diff=cpp
41+
*.tpp text diff=cpp
42+
*.ixx text diff=cpp
43+
*.cppm text diff=cpp
44+
45+
# Python
46+
*.py text diff=python
47+
*.pyi text diff=python
48+
*.pyw text diff=python
49+
50+
# Generated C, C++ and Python binary files
51+
*.a binary
52+
*.lib binary
53+
*.o binary
54+
*.obj binary
55+
*.pyc binary
56+
*.pyo binary
57+
*.pyd binary

AGENTS.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# AGENTS.md
2+
## Markdown の空白に関する方針
3+
Markdown では、改行のために行末を意図的に 2 個の空白にすることがある。
4+
5+
ユーザーから明示的に行末の 2 個の空白の削除を求められた場合、もしくは改行ではなく接続詞または ```, ` といった記号による区切りに変更することがふさわしい場合を除いて、既存の Markdown ファイルおよび MDX ファイルから行末の 2 個の空白を削除してはならない。
6+
27
## レビューについて
38
ライブラリを構成するヘッダファイル、verify ソースコード、ドキュメントと、リポジトリ内のスクリプト、設定ファイル、ドキュメントなどの両方をレビューすること。
49

@@ -14,7 +19,7 @@
1419
- マークダウンの番号なし箇条書きが `- ` である(`* `` - ` などでない)。
1520
- マークダウンの番号付き箇条書きが常に `1. ` である(`2. ` 以降は使わない)。
1621
- ソースコード中のコメントやドキュメントなどの文章は日本語で書かれており、次の項で示すファイルを除いて文体が常体で統一されている(`です``ます` などの敬体が混ざっていない)。
17-
- [pyproject.toml](pyproject.toml)`[project]` 内の `description` および [.gitignore](.gitignore) 中のコメントは除く(英語で記述する)。
22+
- [pyproject.toml](pyproject.toml)`[project]` 内の `description` および [.editorconfig](.editorconfig), [.gitattributes](.gitattributes), [.gitignore](.gitignore) 内のコメントは除く(英語で記述する)。
1823
- 参考文献も除く(人名も含めて、英語で記述する)。
1924
- また、日本語で同じ内容が記述されている場合は、英語などの他の言語が併記されていてもよい。
2025
- リポジトリの [README.md](README.md)[CONTRIBUTING.md](CONTRIBUTING.md)、GitHub Pages 上のドキュメントのトップページ([.competitive-verifier/docs/index.md](.competitive-verifier/docs/index.md) を基に生成される)の文章は日本語で書かれており、文体が敬体で統一されている(以下の例外を除いて、```である` などの常体が混ざっていない)。

0 commit comments

Comments
 (0)