|
| 1 | + |
| 2 | + |
| 3 | +[](https://github.com/w3c/did-extensions/actions/workflows/auto-publish.yml) |
| 4 | + |
| 5 | +# Decentralized Identifier Extensions |
| 6 | + |
| 7 | +This repository contains a list of known DID Extensions that are tracked |
| 8 | +by the |
| 9 | +[W3C Decentralized Identifier Working Group](https://www.w3.org/2019/did-wg/) |
| 10 | +(DID WG) for the purpose of enhancing DID ecosystem interoperability. There |
| 11 | +might be extensions to DIDs other than the ones listed here; this is not |
| 12 | +meant to be an exhaustive or centralized list of extensions. |
| 13 | + |
| 14 | +An Editor's Draft of this repository is available at |
| 15 | +https://w3c.github.io/did-extensions/. |
| 16 | + |
| 17 | +## Adding a DID Method |
| 18 | + |
| 19 | +In order to register a new DID method, you must add a JSON file |
| 20 | +to the [./methods](./methods) directory and |
| 21 | +[open a pull request](https://github.com/w3c/did-extensions/pulls) |
| 22 | +to add the file to this repository. |
| 23 | + |
| 24 | +Here is an [example registration entry](https://w3c.github.io/did-extensions/methods/example.json): |
| 25 | + |
| 26 | +```jsonc |
| 27 | +{ |
| 28 | + // These fields are required |
| 29 | + "name": "example", |
| 30 | + "status": "registered", |
| 31 | + "specification": "https://w3c-ccg.github.io/did-spec/", |
| 32 | + // These fields are optional |
| 33 | + "contactName": "W3C Credentials Community Group", |
| 34 | + "contactEmail": "", |
| 35 | + "contactWebsite": "", |
| 36 | + "verifiableDataRegistry": "DID Specification" |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +Your Pull Request will be automatically validated, please ensure |
| 41 | +that all of the automated tests pass (no errors reported) or |
| 42 | +your submission will not be reviewed. Common reasons for failed |
| 43 | +validation includes invalidly formatted JSON files and missing |
| 44 | +mandatory fields. There will be a checklist that you are expected |
| 45 | +to complete and attest to its accuracy. |
| 46 | + |
| 47 | +In addition to the automated validation, an **AI-based preliminary |
| 48 | +specification review** runs automatically on your pull request. It fetches the |
| 49 | +specification you link to and checks it against the |
| 50 | +[registration checklist](./tooling/spec-review-checklist.md) (DID Method syntax, |
| 51 | +CRUD operations, Security and Privacy Considerations, and so on), then posts an |
| 52 | +advisory pass/fail report as a comment on your pull request. This review is a |
| 53 | +preliminary aid for the registry editors and does not replace their review; if |
| 54 | +it reports a failing required item, address it and push an update to re-run the |
| 55 | +check. Editors can re-run the review at any time by commenting `/ai-review` on |
| 56 | +the pull request. |
| 57 | + |
| 58 | +Once you submit your request, |
| 59 | +your pull request will be reviewed by the registry editors. Changes |
| 60 | +regarding the required criteria may be requested. If there are at |
| 61 | +least two reviews by registry maintainers listed in the CODEOWNERS file, and no objections or |
| 62 | +changes requested, your DID method will be registered after a |
| 63 | +minimum of 7 days and a maximum of 30 days. |
| 64 | + |
| 65 | +## Adding Anything Else |
| 66 | + |
| 67 | +Use the standard fork, branch, and pull request workflow to propose changes to |
| 68 | +the registry. Please make branch names informative—by including the issue or |
| 69 | +bug number for example. |
| 70 | + |
| 71 | +Editorial changes that improve the readability of the registry or correct |
| 72 | +spelling or grammatical mistakes are welcome. |
| 73 | + |
| 74 | +Non-editorial changes MUST go through a review and approval process that is |
| 75 | +[detailed in the registry](https://w3c.github.io/did-extensions/#the-registration-process). |
| 76 | + |
| 77 | +Please read [CONTRIBUTING.md](CONTRIBUTING.md), about licensing contributions. |
| 78 | + |
| 79 | +## Code of Conduct |
| 80 | + |
| 81 | +W3C functions under a [code of conduct](https://www.w3.org/Consortium/cepc/). |
| 82 | + |
| 83 | +## DID Working Group Repositories |
| 84 | + |
| 85 | +- [W3C DID Core Specification v1.0](https://github.com/w3c/did-core) |
| 86 | +- [W3C DID Working Group](https://github.com/w3c/did-wg) |
| 87 | +- [W3C DID Rubric v1.0](https://github.com/w3c/did-rubric) |
| 88 | +- [W3C DID Use Cases v1.0](https://github.com/w3c/did-use-cases) |
| 89 | +- [W3C DID Test Suite and Implementation Report](https://github.com/w3c/did-test-suite) |
0 commit comments