このサイトへの貢献

概要

このサイトはGitHubで管理されています。追記や内容変更などの提案・議論はissueにて受け付けます。また、Pull Requestも受け付けます。GitHubを利用するにはGitHubアカウントが必要です。

このサイトにより説明されている仕様についての議論も同様にGitHub上にて受け付けます。

貢献の方法

貢献には主に2つの方法があります。ひとつはこのサイトの内容について議論すること、もうひとつはページを執筆することです。執筆については、新しいページを作るだけでなく、既存のページのミスの修正、記述の追加などを含みます。

議論はGitHub上のissueによって行います。issueは話題ごとに作られ、GitHubアカウントを持つ人は誰でも書き込むことができます。issueの一覧を参照してください。また、新しいissueを作ることについても誰にでも可能となっています。

このサイトの記述を変更したい場合はPull Requestを作成してください。これには、まずGitHub上でこのサイトのリポジトリ（spec-masao）をforkします。そして内容を変更したコミットを作ってpushすると、uhyo/spec-masaoリポジトリにPull Requestを送ることが可能になります。Pull Requestが管理者に承認されるとそれはマージされ、このサイトに反映されます。

このサイトの目的にそぐわない内容がPull Requestとして送られてきても拒否することがあります。ご了承ください。

サイトの内容について議論する

このサイトのミスを報告したい、内容に疑問がある、内容の追加を提案したいなど、このサイトの内容について議論したい場合はissueを建てることが推奨されます。

仕様について議論する

このサイトは正男に関連する仕様を定義しています（現在はmasao-json-formatのみ）。

この仕様の改善に関する提案・議論もissueで行うことができます。

サイトの内容を修正・追加する

記述のミスを発見した場合、前述のようにissueを建てることも可能ですが、自ら修正してPull Requestを送ることも可能です。

また、新しい正男関連技術に関する記事を追加するPull Requestも歓迎します。

著作権

このサイトの記述の著作権は、それぞれの記述の著者が保持するものとします。

ただし、このサイトの記述はMITライセンス（詳細はライセンスページを参照）のもとで公開されており、このサイトの記述に貢献する場合はあなたの著作物がこのサイトにおいてこのライセンスのもとで公開されることを許諾するものとします。

技術情報

このサイトのリポジトリの扱い方を説明します。

ビルド方法

このサイトのビルド環境を整えるには、まずnode.js（v8以上）が必要です。node.jsがインストールされている状態で次のコマンドを実行してビルドに必要なライブラリをローカルインストールします。

npm install

サイトをビルド結果を確認するには次のコマンドを実行します。

npm run watch

この状態では、http://localhost:8080/でサイトのビルド結果を確認可能です。このコマンドの実行中、ファイルに行った変更は自動的に再ビルドされます。

サイトの構成

各ページのソースコードはsrcディレクトリ以下にあります。1ファイルが1ページに対応し、ページはMarkdownで書かれています。Markdownファイルの先頭の//で始まる行はメタデータとなります。