-
Notifications
You must be signed in to change notification settings - Fork 74
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
Getting Multibase ready for IETF review (align with IANA terminology and registry governance style) #109
Merged
rvagg
merged 33 commits into
multiformats:master
from
bumblefudge:hotfix/clarify-code-column-and-intro-to-match
Aug 24, 2023
Merged
Getting Multibase ready for IETF review (align with IANA terminology and registry governance style) #109
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
12705bb
first-stab-at-closing-4
b7307ea
second-stab-thanks-to-@aarongoldman
e380b70
typo
5c7594a
remove confusing 0xe7 reference for now
b0bf557
third attempt to clarify that base256emoji as codepoint
d451436
typo fix (thanks rvagg)
bumblefudge a39f8ac
tab-aligning tables
a1b75a5
clarify unicode versus utf-8 + fix table
9d69e19
future-proof collision-protection against single-byte multiformats
e814396
update readme language
bumblefudge e79d6d8
align status column with iana terms
bumblefudge d875325
add issue templates to the repo
bumblefudge c3dbd70
refine issue templates
bumblefudge e071bc1
refine issue templates
bumblefudge f07376c
refine issue templates
bumblefudge f7c29ce
refine issue templates
bumblefudge 3e8ce2b
multibase.csv typo
bumblefudge dafe60b
csv typos
bumblefudge b9ca042
csv typos
bumblefudge 52b3c06
undo hard-wrapping of lines per vmx request
bumblefudge be3ab37
embarassingly walking back all my wierd changes
bumblefudge caee143
good catch @vmx
bumblefudge ff1fe45
good catch @vmx
bumblefudge 075fa01
address VMX's comments and refine ### Reserved Terms section
bumblefudge 873440d
rename code to char and flip column order
bumblefudge bb5ae08
Merge branch 'master' into hotfix/clarify-code-column-and-intro-to-match
bumblefudge ccca39b
fix merge conflict artefacts
bumblefudge d773cd8
fix merge conflict artefacts take 2
bumblefudge 4c51364
less required fields in .github/ISSUE_TEMPLATE/BUG-REPORT.yml
bumblefudge 432b270
less required fields in .github/ISSUE_TEMPLATE/BUG-REPORT.yml
bumblefudge e0f3632
typo in README.md
bumblefudge d20580d
require registrants to volunteer as change controller and PR opener
bumblefudge 6eba60f
remove new implementation template for now
bumblefudge File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: "Bug Report - documentation or registry" | ||
description: Report possible bugs in multibase spec, process docs, and/or the multibase registry. | ||
title: "🐛 [DOC/PROCESS BUG] - <title>" | ||
labels: [ | ||
"bug" | ||
] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Description" | ||
description: Please enter an explicit description of your issue, | ||
placeholder: Short and explicit description of your incident, ideally with commit-specific link to lines | ||
validations: | ||
required: true | ||
- type: input | ||
id: reprod-url | ||
attributes: | ||
label: "Reproduction URL" | ||
description: Please enter your GitHub URL to provide a reproduction of the issue | ||
placeholder: ex. https://github.com/multiformats/multibase/ | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: "Context" | ||
description: Please provide additional context | ||
placeholder: "Context or external links needed to explain the possible mistake" | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: "New Registration" | ||
description: Express interest in registering a new encoding | ||
title: "📚 [NEW REGISTRATION] - <title>" | ||
labels: [ | ||
"Registration" | ||
] | ||
body: | ||
- type: input | ||
id: encoding-name | ||
attributes: | ||
label: "Name of encoding" | ||
description: Name this library or system | ||
placeholder: acronyms and abbreviations are fine | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
attributes: | ||
label: "Have read contributing" | ||
description: I have read the [contributing](https://github.com/multiformats/multiformats/blob/master/contributing.md) document | ||
options: | ||
- label: I read it! | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
attributes: | ||
label: "Have checked table" | ||
description: I have reviewed the [multiformats mega-table](https://github.com/multiformats/multicodec/blob/master/table.csv) to assess viable sub-namespace for a registry if applicable | ||
options: | ||
- label: I read it! | ||
- type: checkboxes | ||
attributes: | ||
label: "Willing to open a PR" | ||
description: Once my questions are answered and my plan is confirmed, I will open a PR myself that adds the registration and be its change controller, or close this issue myself if I cannot | ||
options: | ||
- label: I will own this registration | ||
- type: input | ||
id: codepoint | ||
attributes: | ||
label: "Proposed codepoint" | ||
description: Please put here the prefix in the target encoding. By tradition, the highest binary value in the encoding alphabet works well and has a built-in mnemonic if it doesn't conflict with any other entries | ||
placeholder: x | ||
validations: | ||
required: true | ||
- type: input | ||
id: varint-value | ||
attributes: | ||
label: "Proposed varint value for registration in multiformats" | ||
description: Please put here the UTF-8 value that corresponds to that target encoding, for inclusion in the multiformats table, formatted as an [unsigned varint](https://github.com/multiformats/unsigned-varint) | ||
placeholder: See mf/unsigned-varint | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: use-case | ||
attributes: | ||
label: "use-case" | ||
description: Please describe the possible use-cases where this additional codec would be helpful, where this encoding is used currently in the wild, etc. | ||
placeholder: Feel free to provide links for context and use-case descriptions | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: specification | ||
attributes: | ||
label: "Description of relevant prior art and status quo" | ||
description: Please describe relevant prior art and, if already specified in a static public document, the algorithms and configurations needed to deterministically encode/decode | ||
placeholder: Links welcome | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution_and_rationale | ||
attributes: | ||
label: "Proposed solution and rationale" | ||
description: Please describe at a high level what you are exploring building and current open research questions. | ||
placeholder: Detail welcome | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Protocol Labs Vulnerability Disclosure Team | ||
url: mailto:[email protected] | ||
about: Please do NOT open issues related to security of implementations or spec here without contacting the IPFS security team first. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one's a little better, but I'd still prefer this in PR form rather than this asking us to do the PR for them; I'm not really a user of github issue templates (nor particularly a fan! I did my time in JIRA hell already so I can do without the extreme structure), do we have the tools to shunt people toward a PR with all of these things filled out there?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will rework the semantics so that it's more of a placeholder. Maybe something like "open this issue so we can give you timely feedback before you start, but please open a draft PR soon and work there until you can close the issue you just opened" would work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the insertion of this checkbox make it explicit enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I guess -- what I'd like to avoid here is a collection of poorly maintained opened issues with no clear path to getting them closed. If we permission people opening unactionable issues, then we can't take action and have no clear path to closing them.
I think it's fine to have issues opened flagging intent to register, but we have to acknowledge that there's a limit to how long those will be held.