プレリリース版です。正式公開までは、公開済みのファイルも含めて内容が変わることがあります。
Skip to content

出典: https://datamodels.jp/guide/contribute · 文章は CC BY 4.0

貢献する ​

企業、自治体、個人を問わず、誰でも参加できます。ルールは全員同じです。日本語でも英語でも構いません。

何かを頼むときは、合う Issue フォームを使います。Issue フォームは、項目に記入して送る GitHub のページです。GitHub のアカウント(無料)が要ります。無ければ登録してください。下の節ごとに、フォームを使う場面、書くこと、そのあとの流れを説明します。

フォームの内容が、そのままサイトに載ることはありません。まずメンテナーが確かめます。そのうえで、自動の検査とレビューを通った Pull Request(カタログのファイルの変更案)だけがカタログに入ります。

Issue は誰でも読めます。パスワード、API キー、トークン、ログイン URL は書かないでください。

質問、不具合、アイデアは、ふつうの Issue で知らせてください。「この属性の意味が分からない」も歓迎です。

モデルや属性を提案する ​

新しいモデルや、モデルを使う多くの人に役立つ属性は、モデルの提案フォームで提案します。スキーマを書く必要はありません。

カタログに載せるモデルの条件は、モデルのルールにあります。既存の標準に基づき、実際のデータがあることなどです。自分のプロジェクトだけで使うモデルは、自分のサイトで公開できます(自分のデータモデル)。自分たちのためだけに属性を足すときや、名前だけを変えるときは、提案は要りません(どのページを読むか)。

フォームには、1 件のデータが何を表すか、そのデータをいま誰がどのくらい持っているか、基にする標準を書きます。合う標準が無ければ、その理由を書きます。分かれば、ほかにそのモデルを使いそうな組織と、データの例も書きます。Issue を開くと、似ているモデルが自動でコメントされます。そのまま使えるモデルや、拡張できるモデルがないか確かめてください。

そのあと:まず Issue で提案について話し合います。次に、提案した人かメンテナーが Pull Request でモデルを書きます(自分でファイルを変える)。自分でコードを書けなくても構いません。取り込まれると、モデルはドラフトとして公開されます。別々の 2 つの組織が自分のシステムで使うと、安定になります(段階)。

提案Issueドラフトカタログに入る安定安心して使える非推奨公開は続くレビュー・マージ2 つの組織が実装新規には使わない

モデルの提案フォームを開く

拡張を載せる ​

組織がカタログのモデルに属性を足して使っているなら、拡張の登録フォームで、モデルのページの「このモデルをもとにしたもの」に載せられます。同じ意味の属性が要るほかの組織がその名前を使えるので、お互いのデータがそろいます。ツールキットで作った自分のサイトで公開しているなら、フォームは要りません。サイトを載せれば(次の節)、サイトのモデルが自動でモデルのページに載ります。

フォームには、拡張したモデル(例:task/Task)、組織名(日本語と英語)、足した属性ごとの名前・IRI・意味を書きます。IRI は、属性の名前として使う Web アドレスです。自分の組織の Web サイトなど、自分で管理するドメインのアドレスを使います。自分の @context と、基にしたバージョンも書きます。組織を代表していることと、内容を誰でも再利用できること(CC0 1.0)にも同意します。モデルのページのリンク「フォームで登録してください」から開くと、モデル名が入った状態になります。@context が初めてなら、属性を足すを参照してください。@context は拡張ビルダーでも作れます。

そのあと:メンテナーが、登録した人が組織を代表していることを確かめます。メンテナー(または登録した人)が Pull Request で登録し、名前がモデルの属性と重なっていないかなどを自動で検査します。取り込まれると、数分でモデルのページと catalog.json に載ります。属性は申告のまま載せます。設計の良し悪しは、datamodels.jp では確かめません。記入の例は #189 にあります。

拡張の登録フォームを開く

データモデルのサイトを載せる ​

ツールキットで作った自分のサイトでデータモデルを公開しているなら(サイトを始める)、サイトの登録フォームでデータモデルのサイトの一覧に載せられます。サイトのモデルがカタログのモデルをもとにしていれば、そのモデルのページの「このモデルをもとにしたもの」にも、足した属性と一緒に載ります。

フォームには、サイトの URL、catalog.json の URL、名前(日本語と英語)を書きます。名前は catalog.json の title(無ければ publisher の名前)で、一覧ではこの名前を使います。チェックを入れて、サイトを運営していること(または運営者の代わりに申請していること)を示します。サイトとモデルを datamodels.jp が載せることにも同意します。サイトが移ったり閉じたりしたら、Issue で知らせてください。

そのあと:メンテナーが Pull Request でサイトを一覧に足します。その Pull Request でサイトの catalog.json を読み込み、読んだ内容をレビューで確かめます。モデルの中身は datamodels.jp では確かめません。それぞれのサイトが自分のモデルを決めます。

サイトの登録フォームを開く

他のカタログを知らせる ​

「他のデータモデルカタログ」に載っていないデータモデルや語彙のカタログを知っていたら、他のカタログの登録フォームで知らせてください。自治体標準オープンデータセットのような、データの標準の形も含みます。世界のもの、日本のもの、1 つの組織のもの、どれでも構いません。ログインや契約なしで、誰でも読めるものに限ります。

フォームには、カタログの名前、ページ、公開している組織、範囲、内容と形式、datamodels.jp との関係、ライセンスを書きます。分からない項目には、分かることだけ、または「不明」と書いてください。メンテナーが質問します。

そのあと:メンテナーがカタログを見て、Issue で質問することがあります。合えば、Pull Request でページに載せます。

他のカタログの登録フォームを開く

自分でファイルを変える ​

依頼を送るだけなら、上のフォームで足ります。Pull Request でカタログのファイルを自分で変えるときは、GitHub の CONTRIBUTING.md に従ってください。Pull Request の手順、決め方、署名(DCO)を説明しています。貢献した内容は、カタログのライセンスで公開します。