Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Proposal to add `buildInstructions` in

See original GitHub issue

Issue Description

During the last few months we have reviewed the additional 10 properties that aren’t in and are only in CodeMeta, buildInstructions is one of these properties.

The definition used on CodeMeta is:

link to installation instructions/documentation

Documentation is a main part in software development and is crucial in the understanding of the software and its functionalities. There are different types of documentation:

  • user manual
  • build instructions
  • tutorials

Therefore, when describing a software project or artifact with metadata it is useful to have access to its documentation and its build instructions.


In the crosswalk table at the moment this property isn’t used and it might be more appropriate to rename buildInstructions to documentationUrl before submitting the issue to

Another option is to have both metadata properties (which are different).

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:20 (10 by maintainers)

github_iconTop GitHub Comments

tmorrellcommented, Jul 1, 2021

I’ve closed my PR so there can be more discussion on how to implement this.

arfoncommented, Jun 1, 2021

Another option is to have both metadata properties (which are different).

My vote would be to try and standardize on documentation and drop buildInstructions in the long run for two reasons:

  1. It limits the size of the vocabulary.
  2. IMO buildInstructions is just one example of a possible many subsets of a documentation property. So if we want to go in that direction, we should probably think about others.
Read more comments on GitHub >

github_iconTop Results From Across the Web

Proposal to add `readme` to · Issue #247
This issue is part of the SCIWG CodeMeta task force aiming to add all additional properties into Text proposal for the adding...
Read more >
How we work
The "pending" extension contains one or more self-contained proposals that add new terms (types, properties and enumerated values) to The ...
Read more >
Getting started with using Microdata
This guide will help get you up to speed with Microdata and so that you can start adding markup to your web...
Read more >
Release listing
Issue #2506: Add vocabulary to help online vendors publish information about their shipping-related policies, associatted with an Offer using the ...
Read more >
Recipe - Type
Property Expected Type Description alternativeHeadline Text A secondary title of the Creativ... audio AudioObject or. Clip or MusicRecording An embedded audio object. character Person Fictional person...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found