codemeta generation tool

オープン
#14 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
css, html, javascript, react
領域
frontend, web-dev

調査の方向性

Start by reading layouts/shortcodes/react-schema.html and static/schema.json, then inspect the linked generator at https://codemeta.github.io/create/. The issue proposes polishing the generator and adding useful fields such as author and contributor roles, but does not define a complete scope or acceptance criteria; clarify those before starting. Done should mean the agreed fields and behavior work in the form and generated codemeta.json.

索引モデルが issue の本文から書いたものです。

説明

Hey @amoeba,

Thanks for the pointers on javascript and React-JS. I've adapted your minimal example into an prototype for users to generate codemeta.json files (and integrated it into the Hugo styling of the site):

https://codemeta.github.io/create/

Main source file is added in as a shortcode, (though should probably go directly into content/create.html) . Reads a very incomplete json-schema file from static/schema.json since I thought it made sense to separate that out (technically still a js file and not a json file, guess i should fix that too).

The layout of the form does take up a lot of space, so not sure if it will ever make sense to support all possible codemeta fields. The styling is a bit subtle at the moment -- the box color bar will go from purple (the theme color) to red if you type a non-URI into url or codeRepository.

I hacked in the method to download a codemeta.json file by myself (thanks stackoverflow really, but still my first time writing javascript 🐱, so it may very well be terrible...

Also, I didn't see a way to have fields like @type and @context elements be automatically pre-populated in the output JSON but not visible in the form part. Currently it doesn't use any custom uiSchema styling, maybe there's a "hide" option?

Anyway, let me know what you think!

If I can polish this up a bit and add enough fields to actually be somewhat useful (e.g. author / contributor roles) I think this could make a nice easy entrypoint for getting started with codemeta.

thanks again for getting me rolling on this!

主要言語
CSS
スター
5
フォーク
23
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

codemeta/codemeta.github.io のほかの issue

codemeta/codemeta.github.io の issue をすべて見る

似ている issue

Web Dev の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。