codemeta generation tool

Ouverte
#14 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
css, html, javascript, react
Domaine
frontend, web-dev

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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!

Langage dominant
CSS
Étoiles
5
Forks
23
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de codemeta/codemeta.github.io

Toutes les issues de codemeta/codemeta.github.io

Issues similaires

Plus d'issues Web Dev

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.