CONTRIBUTING.md

About this guide

主に将来の自分（@xhiroga）に向けた、このリポジトリのメンテナンスのためのルールです。

アクセシビリティ

• GitHub Pagesで公開するサイトは日本語読者（主に自分）向けとして、日本語で記載します。
• ソースコードのコメントは、ニュアンスが直感的に伝えられない場合を除いて英語で記載します。

フォーマット

Markdownのスタイルガイドを参照してください。

引用文献フォーマット

CSの分野の学会などでメジャーなAPA形式を採用します。Google Scholar Buttonを用います。

フォルダ構成

分類

...
├── computer-science        類目(MainClass) - 1次区分
│   ├── big-data            綱目(Division) - 2次区分
│   │   ├── _src
│   │   │   ├── getting-started
...
│   │   ├── README.md
...
├── README.md
...

• 分類は NDC Vocabulary Definition を参考にしています。
• ソースコードは {綱目}/_src 以下のディレクトリに配置します。Jekyllのビルド対象外にするためです。

:::note info 要目(Section)は、2023-02-19の更新で任意になりました。
GitHub Pagesでのホスティングのためにマークダウンファイル(*.md)とソースコード(_src/**)を分けた結果、ネストが深くなることを懸念したものです。 :::

類目(MainClass)

図書館の分類法を参考にして下さい。

• 国立国会図書館オンライン
• 日本十進分類法
• 国立国会図書館分類表
• Library of Congress >> Books/Printed Material
• Library of Congress Classification Outline
• アメリカ議会図書館分類表(英) - Wikipedia
• CIP - アメリカ教育統計センターによる、教育プログラム分類体系

綱目(Division)

類目によって分類方法が異なります。

Computer science

• Computer science - Wikipedia

Software Engineering

• Zenn - Topics
• Qiita - Tags
• AWS CLI Command Reference - AWSのセクションのフォルダ名に用いる。

開発

make
open http://localhost:4000

参考

• About this guide  |  Google developer documentation style guide  |  Google Developers
• js-primer/CONTRIBUTING.md at master · asciidwango/js-primer · GitHub