Skip to content

w3c/vc-extensions

Repository files navigation

W3C Logo

Echidna Auto-publish

Verifiable Credential Extensions

This repository contains a list created by the W3C Verifiable Credentials Working Group (VC WG) for the purpose of discovering specifications known to exist in the Verifiable Credentials Ecosystem.

An Editor's Draft of this repository is available at https://w3c.github.io/vc-extensions/.

Adding New Entries to the List

In order to add a new specification to this list, you must add a JSON file to the ./specifications directory and open a pull request to add the file to this repository.

Here is an example specification entry:

{
  // These fields are required
  "name": "Example VC",
  "summary": "Used to demonstrate examples for Verifiable Credentials.",
  "specification": "https://example.github.io/example-spec/",
  // categories include: vc, credentialStatus, credentialSchema,
  //                     refreshService, termsOfUse, evidence, and proof
  "category": "vc",
  "maintainerEmail": "maintainer@community.example",
  // These fields are optional
  "maintainerName": "Example Community Group",
  "maintainerWebsite": "https://example.github.io/",
  // RDF vocabularies in yml2vocab format
  "vocabulary": ["https://example.github.io/vocabularies/example.yml"]
}

Your Pull Request will be automatically validated, please ensure that all of the automated tests pass (no errors reported) or your submission will not be reviewed. Common reasons for failed validation includes invalidly formatted JSON files and missing mandatory fields. There will be a checklist that you are expected to complete and attest to its accuracy. Once you submit your request, your pull request will be reviewed by the directory maintainers. Changes regarding the required criteria may be requested. If there are no objections or changes requested, your specification will be added after a minimum of 7 days and a maximum of 30 days.

Adding Anything Else to this List

Use the standard fork, branch, and pull request workflow to propose changes to the directory. Please make branch names informative—by including the issue or bug number for example.

Editorial changes that improve the readability of the directory or correct spelling or grammatical mistakes are welcome.

Non-editorial changes MUST go through a review and approval process that is detailed in the directory.

Please read CONTRIBUTING.md, about licensing contributions.

Code of Conduct

W3C functions under a code of conduct.

VC Working Group Repositories