Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix registration process requirements #356

Closed
wants to merge 14 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/register_did_method.md
@@ -0,0 +1,47 @@
## New DID Method Registration
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need to agree to a documented process before we can change the registry to support JSON files, please review this section.


### Required Registration Criteria

Please confirm:

- [ ] The DID Method specification defines the identifer syntax.
- [ ] The DID Method specification defines the supported DID Operations.
- [ ] The DID Method specification contains a Privacy and Security Considerations.
Comment on lines +7 to +9
Copy link
Member

Choose a reason for hiding this comment

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

would it be appropriate/helpful to link to the relevant sections of the spec here?


### Optional Registration Criteria

Consider ensuring:

- [ ] The registration entry contains contact information.
- [ ] The registration entry contains registry information.

### Registration Process

In order to register a New DID Method, you must add a json file to [./methods](./methods).

Here is an example registration entry:

```json
{
"status": "registered",
"name": "example",
"specification": "https://w3c-ccg.github.io/did-spec/",
"contact": "W3C Credentials Community Group",
"registry": "DID Specification"
}
```

Please ensure your pull request and entry are passing the required validation rules.

See the schema requirements for registry entries [here](./tooling/did-method-registry-entry.yml).

### Registration Review Process

Your pull request will be reviewed by the registry editors.

Changes regarging the required criteria may be requested.

If there are no objections or changes requested,

your method will be registered after a minimum of 7 days.

Comment on lines +40 to +47
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this needs to be multiple paragraphs... For certain, the last two lines of text should be one.
Also, fixed "regarging" typo

Suggested change
Your pull request will be reviewed by the registry editors.
Changes regarging the required criteria may be requested.
If there are no objections or changes requested,
your method will be registered after a minimum of 7 days.
Your pull request will be reviewed by the registry editors.
Changes regarding the required criteria may be requested.
If there are no objections or changes requested,
your method will be registered after a minimum of 7 days.

24 changes: 24 additions & 0 deletions .github/workflows/verify-registry.yml
@@ -0,0 +1,24 @@
name: DID Method Registry Validation
on: [push]
jobs:
validate-registry-entries:
runs-on: ubuntu-latest
steps:
- name: Begin CI...
uses: actions/checkout@v2
- name: Use Node 14
uses: actions/setup-node@v1
with:
node-version: 14.x
- name: Install
working-directory: tooling
run: npm i

# This step will be updated to verification only,
# when the registry is built from the json files
# added by the registration process.
- name: Generate and then Verify the DID Method Registry
working-directory: tooling
run: npm run registry:generate


4 changes: 4 additions & 0 deletions .gitignore
Expand Up @@ -7,3 +7,7 @@ vocabs/v1/test.ttl
.DS_Store
.idea
unresolveable-test-dids.json


# remove when methods are used to build table.
methods
5 changes: 5 additions & 0 deletions index.html
Expand Up @@ -2376,6 +2376,11 @@ <h3 id="resource">resource</h3>

</section>

<section
data-include="sections/did-method-registry.html"
Copy link
Contributor Author

@OR13 OR13 Nov 2, 2021

Choose a reason for hiding this comment

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

this allows us to generate the entire did method registry section as a separate html file, and then import it into the main spec to be rendered.

data-include-replace="true"
></section>

<section>
<h1>DID Methods</h1>

Expand Down