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

CIP-0067, CIP-0068 | Add Clarification for Edits and Modification #586

Merged
merged 18 commits into from
Nov 14, 2023

Conversation

Crypto2099
Copy link
Collaborator

  • Some minor grammatical/typographical errors were fixed
  • Reformatting some table blocks w/o any modification of content
  • Update existing language in a few places to follow RFC 2119 format
  • Add documentation property (URL) to the CIP-67 registry.json file. If we are going to require that future extensions of the CIP-68 standard be submitted via a separate CIP, then when documenting them within the context of the CIP-67 registry it's important for implementers to be able to find documentation on these asset label names and how to support them (if necessary).
  • Add blocks clarifying the methods and mechanisms to submitting updates or extensions to CIP-68 standard following RFC 2119 format.

Happy to discuss and refine this as needed but consider this simply a first draft.

KtorZ and others added 2 commits June 9, 2023 09:58
  Clarify the use of version, introduce changelog.

  Fixes cardano-foundation#520.
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

@Crypto2099 I am really happy with this so far even though you may still consider it a draft. We have 2 pending PRs based on this material (#504 #551) & I'll link them back here next so those authors & reviewers can help make sure the new process & language will address all pending concerns.

CIP-0068/README.md Show resolved Hide resolved
@rphair rphair changed the title CIP-67 + CIP-68: Add Clarification for Edits and Modification CIP-0067, CIP-0068 | Add Clarification for Edits and Modification Aug 31, 2023
@rphair
Copy link
Collaborator

rphair commented Aug 31, 2023

@Crypto2099 since I know you had already corrected grammar I did find something which I believed to be still incorrect & took a stab at fixing what appeared to be both a couple grammar errors + a nonsensical technical statement: please double check after the last 2 commits.

@Crypto2099
Copy link
Collaborator Author

@Crypto2099 since I know you had already corrected grammar I did find something which I believed to be still incorrect & took a stab at fixing what appeared to be both a couple grammar errors + a nonsensical technical statement: please double check after the last 2 commits.

These couple additional grammatical errors also seem to make sense and fit in the scope of this so happy with those changes :)

CIP-0068/README.md Show resolved Hide resolved
CIP-0068/README.md Outdated Show resolved Hide resolved
CIP-0068/README.md Outdated Show resolved Hide resolved
* Inclusion of an "extension_boilerplate.md" file for reference in subsequent PRs.
* Update headers to current CIP-0001 format
@Crypto2099
Copy link
Collaborator Author

@SamDelaney would love your feedback on the latest changes and the addition of the extension_boilerplate.md file added to the CIP-0068 directory as a convenient means of referencing the extension and modification boilerplate in subsequent CIPs.

Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

With versioning addressed in last commit as per #586 (review) I'm in agreement with all this. 😎 (edit, p.s. I had missed the header preamble changes with the inappropriate Meta category)

CIP-0068/README.md Outdated Show resolved Hide resolved
CIP-0067/README.md Outdated Show resolved Hide resolved
Crypto2099 and others added 2 commits October 17, 2023 10:41
Co-authored-by: Ryan Williams <[email protected]>
Co-authored-by: Ryan Williams <[email protected]>
@rphair
Copy link
Collaborator

rphair commented Oct 17, 2023

FYI @Crypto2099 we need a rebase to fix the merge conflict after finally merging #551 😬

Crypto2099 and others added 7 commits November 8, 2023 10:05
Co-authored-by: Ryan Williams <[email protected]>
* Inclusion of an "extension_boilerplate.md" file for reference in subsequent PRs.
* Update headers to current CIP-0001 format
…nto donoteditCIP68

# Conflicts:
#	CIP-0067/README.md
#	CIP-0068/README.md
Co-authored-by: Ryan Williams <[email protected]>
@Crypto2099
Copy link
Collaborator Author

Okay phew! That rebase was fun (not really) but I think we got it all sorted. Would appreciate some eyes @Ryun1 @rphair to make sure I didn't lose any of the formatting changes we had made along the way.

Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

Thanks @Crypto2099 for the fine tuning & rebase... and for not doing a force push and overwriting the commit history. There's (perhaps unavoidably) some duplication in the branch but it matches the scope of changes that I originally remember. So if you can confirm nothing has been taken away, then I can confirm nothing inappropriate has been added 😅

Copy link
Collaborator

@Ryun1 Ryun1 left a comment

Choose a reason for hiding this comment

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

Great work on this @Crypto2099 🚀

@rphair
Copy link
Collaborator

rphair commented Nov 14, 2023

great: merging so we can more forward with this as a baseline for merge conflict resolution of #523 as per meeting decision today.

@rphair rphair merged commit de76120 into cardano-foundation:master Nov 14, 2023
Ryun1 added a commit to Ryun1/CIPs that referenced this pull request Nov 17, 2023
…rdano-foundation#586)

* Bump CIP-0068 version for RFT

  Clarify the use of version, introduce changelog.

  Fixes cardano-foundation#520.

* Changes to CIP-67 and CIP-68 to inform how, when, and why changes should be made to either CIP-67 or CIP-68

* fix a few grammar errors in 1 sentence of original document

* fixing error in my error fix / clarification

* * Minor grammatical and feedback updates.
* Inclusion of an "extension_boilerplate.md" file for reference in subsequent PRs.
* Update headers to current CIP-0001 format

* Update CIP-0068/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-0067/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Update CIP-0067/README.md

Co-authored-by: Ryan Williams <[email protected]>

* Changes to CIP-67 and CIP-68 to inform how, when, and why changes should be made to either CIP-67 or CIP-68

* fix a few grammar errors in 1 sentence of original document

* fixing error in my error fix / clarification

* * Minor grammatical and feedback updates.
* Inclusion of an "extension_boilerplate.md" file for reference in subsequent PRs.
* Update headers to current CIP-0001 format

* Update CIP-0068/README.md

Co-authored-by: Ryan Williams <[email protected]>

---------

Co-authored-by: KtorZ <[email protected]>
Co-authored-by: Robert Phair <[email protected]>
Co-authored-by: Ryan Williams <[email protected]>
@rphair rphair mentioned this pull request Aug 20, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants