Skip to content

Commit ffec91a

Browse files
committed
feat: add submitter and reviewer guidelines
1 parent 8790c21 commit ffec91a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ Selecting the appropriate tag helps maintain organization in the table and provi
7070

7171
### Adding new multicodecs to the table
7272

73+
#### Guidelines for submitters
74+
7375
The process to add a new multicodec to the table is the following:
7476

7577
1. Fork this repo
@@ -88,6 +90,28 @@ Codec names should be easily convertible to constants in common programming lang
8890

8991
The `validate.py` script can be used to validate the table once it's edited.
9092

93+
Before submitting a new code please:
94+
- [ ] Consider if an existing code works for you
95+
- [ ] Submit a link to the specification the code refers to so that others may reference and use it
96+
- [ ] Give some context on the intended use
97+
98+
To keep the initial review process lightweight and encourage experimentation, newly added codes are probationary.
99+
100+
Six months after submission, the submitter should comment on the merged PR with an update on usage.
101+
If there is no comment or the code is no longer in use, a PR to remove it will be opened. If no objections are raised within 3 months, the code will be removed.
102+
103+
#### Guidelines for reviewers:
104+
105+
For reviewers of new codes please consider:
106+
- [ ] Does the code fit within the relevant tagged category?
107+
- [ ] Is this code needed or could it be served by an existing code?
108+
- [ ] Is the byte size of the requested code suitable or should it be higher?
109+
- [ ] Is the number of codes requested suitable?
110+
- [ ] Is approval of the code unlikely to cause the need for many more codes in a way that is avoidable or would warrant a new category?
111+
- [ ] Is the name of the code unlikely to be confusing or problematic for users?
112+
113+
While reviewers are frequently experienced in the projects of the managed categories and can give guidance around the usage of codes and potential alternatives that better fit the guidelines they are not meant to gate a user's ability to leverage multicodec tooling. If a user has a code that fits the guidelines it should be approved even if the reviewer thinks an alternative approach should be acceptable but the submitter disagrees.
114+
91115
## Implementations
92116

93117
- [go](https://github.com/multiformats/go-multicodec/)

0 commit comments

Comments
 (0)