Skip to content

Commit 84b7436

Browse files
committed
feat(CONTRIBUTING): 文章の修正についてを追記
表記揺れの辞書について
1 parent 3b9ed6b commit 84b7436

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,21 @@
44

55
Contributeは大きく分けて、既存の文章の修正や執筆 と Proposalの提案などがあります。
66

7-
Proposalとは、このライブラリはこういうプラグインのアーキテクチャを持っているというのをIssueを立てる形の事を言います。
7+
## 文章の修正
8+
9+
typoなどを見つけた場合は1文字修正でもいいので、Pull Requestを送っていただけると助かります。
10+
11+
表記揺れを発見した場合は単純にIssueを立ててもらうか、Pull Requestでの修正をいただけると嬉しいです。
12+
13+
また、この書籍では[test/prh-rule.yaml](test/prh-rule.yaml)という辞書を使い表記揺れを辞書でテストできるようにしています。
14+
辞書による表記揺れの検知が可能そうであるなら、そちらも合わせてご指摘いただけるとありがたいです。
15+
16+
- [textlint + prhで表記ゆれを検出する | Web Scratch](http://efcl.info/2015/09/14/textlint-rule-prh/ "textlint + prhで表記ゆれを検出する | Web Scratch")
817

918
## Proposalの書き方
1019

20+
Proposalとは、このライブラリはこういうプラグインのアーキテクチャを持っているというIssueを立てる事を言います。
21+
1122
例えば、XXXというライブラリ/ツールのアーキテクチャについてのIssueを立てる場合、
1223
以下のような事が1行とかでもいいので書かれていれば参考になります。
1324

0 commit comments

Comments
 (0)