この書籍ではJavaScriptにおけるプラグインのアーキテクチャを色々なライブラリやツールを元に紹介する形をとっています。
Contributeは大きく分けて、既存の文章の修正や執筆 と Proposalの提案などがあります。
Proposalとは、このライブラリはこういうプラグインのアーキテクチャを持っているというのをIssueを立てる形の事を言います。
例えば、XXXというライブラリ/ツールのアーキテクチャについてのIssueを立てる場合、 以下のような事が1行とかでもいいので書かれていれば参考になります。
仕組みについて調べるのが大変な場合は飛ばしてもらっても問題ありません。 JavaScriptはとにかく柔軟な言語なので、こういうプラグインの形式を取ってるというのを知らせるだけでも有用だと思います。
# XXXのアーキテクチャ
## どう書ける?
- 実際のコード例
## どういう仕組み?
- prototypeを拡張しているなど具体的な仕組み
- その機構のコードへのリンク
- その仕組みやプラグインについてドキュメントへのリンク
## どういう事に向いてる?
- どういう用途で使われてる(ユースケース)
- 変換する毎にファイルとして吐き出さないので、高速に複数の変換をするのに向いている 等
## どういう事に向いていない?
- 変換の仕組み上書き換え等を行うプラグインを扱いにくい 等
## この仕組みを使ってるもの
- XXX以外にも同様の仕組みを使ってるものがあるなら
----
## チェックリスト
- [ ] どう書ける?
- [ ] どういう仕組み?
- [ ] どういう用途に向いている?
- [ ] どういう用途に向いていない?
- [ ] この仕組みを使ってるもの
- [ ] 実装してみよう
- [ ] エコシステム
以下からこのテンプレートを使ったIssueを立てることが出来ます。
現在あるProposal一覧を参考にしてみると良いかもしれません。
$ npm test を実行するとコードや文章に対するテストが実行されます。
npm test文章はtextlintによる単語のチェックが行われます。
Angular.jsのGit Commit Guidelinesをベースとしています。
以下のような形で1行目に概要、3行目から本文、最後に関連するIssue(任意)を書きます。
feat(ngInclude): add template url parameter to events
The `src` (i.e. the url of the template to load) is now provided to the
`$includeContentRequested`, `$includeContentLoaded` and `$includeContentError`
events.
Closes #8453
Closes #8454
scope commit title
commit type / /
\ | |
feat(ngInclude): add template url parameter to events
body -> The 'src` (i.e. the url of the template to load) is now provided to the
`$includeContentRequested`, `$includeContentLoaded` and `$includeContentError`
events.
referenced -> Closes #8453
issues Closes #8454
1行のfeatやfixといったcommit typeは、迷ったらとりあえずchoreと書いて、scopeも省略して問題ないので以下のような形でも問題ありません。
chore: コミットメッセージ
このコミットメッセージの規約はconventional-changelogによる自動生成のためでもありますが、 取り込むときに調整できるので無視してもらっても問題はありません。
以下を見てみると良いかもしれません。