Skip to content

Commit 821445f

Browse files
committed
Update basic pull request template.
1 parent 3cfa9be commit 821445f

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Instructions for Pull Requests
2+
3+
Please read these instructions thoroughly in order to ensure that your pull
4+
request is processed in a timely manner. This document contains detailed
5+
instructions for registering a compression table. If your pull request concerns
6+
some other change to the repository, you may delete all of the text in this text
7+
box and write up a more relevant description.
8+
9+
There is a Compression Table Registration Form below that MUST be included in a
10+
registration request. The form includes check boxes that you are expected to
11+
fill out when you submit your request.
12+
13+
Once you submit your request, your pull request will be reviewed by the registry
14+
maintainers. Changes regarding the required criteria may be requested. If there
15+
are no objections or changes requested, your registration will be registered
16+
after a minimum of 7 days.
17+
18+
## DID Method Registration Process
19+
20+
In order to register a new compression table, you must add a YAML file to the
21+
[./tables](./tables) directory.
22+
23+
Here is an example registration entry:
24+
25+
```yaml
26+
---
27+
domain: Example Foo Problem Domain
28+
contact: yourGithubHandle
29+
mode: default
30+
provisional: true
31+
compressionTable:
32+
- type: context
33+
table:
34+
32768: https://www.w3.org/ns/credentials/v2
35+
32769: https://www.w3.org/ns/credentials/examples/v2
36+
32770: https://w3id.org/utopia/v2
37+
- type: https://w3id.org/security#cryptosuiteString
38+
table:
39+
1: ecdsa-rdfc-2019
40+
2: ecdsa-sd-2023
41+
3: eddsa-rdfc-2022
42+
```
43+
44+
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 YAML files and missing mandatory fields.
45+
46+
----- REGISTRATION FORM: DELETE EVERYTHING ABOVE THIS LINE ------
47+
48+
### Compression Table Registration
49+
50+
As a CBOR-LD compression table registrant, I have ensured that my DID method registration complies with the following statements:
51+
52+
- [ ] The YAML file I am submitting has [passed all automated validation tests below](#partial-pull-merging).

0 commit comments

Comments
 (0)