Skip to content

Comments

Suggestion to insert SPDX Identifier for Community Specification License#16

Merged
mkdolan merged 3 commits intodevelopmentfrom
spdx-identifier
Aug 25, 2022
Merged

Suggestion to insert SPDX Identifier for Community Specification License#16
mkdolan merged 3 commits intodevelopmentfrom
spdx-identifier

Conversation

@jpradocueva
Copy link

As suggested in Issue #6
This PR introduces the SPDX Identifier in the README file as well as a statement that can be inserted in documents to represent this license graphically.

@swinslow comment

As suggested in Issue #6
This PR introduces the SPDX Identifier in the README file as well as a statement that can be inserted in documents to represent this license graphically.
@jpradocueva jpradocueva requested a review from mkdolan August 19, 2022 17:26
Readme.md Outdated

The SPDX Identifier for the Community Specification V1.0 is, [`Community-Spec-1.0`](https://spdx.org/licenses/Community-Spec-1.0.html).

The statement to insert on files to represent this license is:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would revise this to say something like "A badge indicating the Community Spec v1.0 license can be added to a MarkDown file with the following text:

Readme.md Outdated

The statement to insert on files to represent this license is:

![APM license](https://img.shields.io/badge/License-Community_Spec-brightgreen)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things here:

  • This probably needs to be enclosed in backticks, otherwise the image renders instead of being kept as plaintext
  • Was the "APM license" alt-text inadvertently added? I don't think the APM reference applies here...
  • I'd probably specifically structure the badge URL to display the correct SPDX identifier

So I think this line would probably instead get the following (with backticks surrounding it for the markdown, and note the double hyphens in the URL):

![Community-Spec-1.0 license](https://img.shields.io/badge/License-Community--Spec--1.0-brightgreen)

Copy link

@swinslow swinslow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @jpradocueva!

@mkdolan mkdolan changed the title Suggestion to insert SPDX Identifier for SC Suggestion to insert SPDX Identifier for Community Specification License Aug 25, 2022
@mkdolan mkdolan merged commit cf0db28 into development Aug 25, 2022
@mkdolan mkdolan deleted the spdx-identifier branch August 25, 2022 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants