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-0001 | Titles for CIPs with common purpose #594

Merged

Conversation

rphair
Copy link
Collaborator

@rphair rphair commented Sep 19, 2023

Discussion begun in #590 and currently, as agreed in today's editor meeting, with consensus so far that:

  • the "pipe" (|) is a better choice than the colon to avoid YAML errors
  • this may also be applicable to other CIP names: e.g. may be helpful for new token types as per CIP-0068, so should be generalised into CIP-0001... as opposed to CIP-0030 which would only cover extensions to the web-wallet bridge.

On that last note we also suggested @Ryun1 might add a similar instruction to CIP-0030 that those extensions be named as such (with Web-Wallet Bridge |), once it's confirmed here. In anticipation of this I've added an H6 (so far unused) to the document so it can be referenced easily with an external link.

BTW the merged CIP-0095 itself now follows this convention (Web-Wallet Bridge | Governance): https://github.com/cardano-foundation/CIPs/tree/master/CIP-0095

@rphair rphair added the Update Adds content or significantly reworks an existing proposal label Sep 19, 2023
@rphair rphair mentioned this pull request Sep 19, 2023
rphair added a commit to Scitz0/CIPs that referenced this pull request Sep 19, 2023
rphair added a commit to Scitz0/CIPs that referenced this pull request Sep 19, 2023
@rphair
Copy link
Collaborator Author

rphair commented Sep 19, 2023

FYI, hold on review... there is a problem using the | character in a table (even when quoted as code), which my happy-go-lucky markdown editor rendered properly... though it's considered a further table column on GitHub & therefore disappears here. Will push out another commit or two based on some testing & syntax changes.

@rphair
Copy link
Collaborator Author

rphair commented Sep 19, 2023

... OK, I think it's fixed now, using HTML <code> syntax + a charcode for the "pipe" which (as per the DTD for HTML based documents) should avoid the problems pointed out in #591 (i.e. the "easy fix" is escaping with \ but that wouldn't be portable).

@rphair
Copy link
Collaborator Author

rphair commented Sep 19, 2023

Note: discussion is now open on reverting to the second-most-popular suggestion of using the - sign as a delimiter (suggested in #590 (comment) & #595 (comment)) especially because the extra markup required to put | in a table is bound to cause even worse problems than the YAML-unfriendly :. 😰

@rphair
Copy link
Collaborator Author

rphair commented Sep 21, 2023

Reverted back to - for a delimiter as per reported problem & consensus in #595 (comment).

rphair added a commit to rphair/CIPs that referenced this pull request Sep 21, 2023
rphair added a commit to Scitz0/CIPs that referenced this pull request Sep 21, 2023
rphair added a commit to Scitz0/CIPs that referenced this pull request Sep 21, 2023
rphair added a commit that referenced this pull request Sep 21, 2023
* merged CIP-0095 and corrected its name

* wallet API delimiter changed to - as per updated #594

* already merged CIP-0095 also needs delimiter change
@rphair rphair merged commit 1a519a7 into cardano-foundation:master Sep 27, 2023
Ryun1 pushed a commit to Ryun1/CIPs that referenced this pull request Nov 17, 2023
…dano-foundation#595)

* merged CIP-0095 and corrected its name

* wallet API delimiter changed to - as per updated cardano-foundation#594

* already merged CIP-0095 also needs delimiter change
Ryun1 pushed a commit to Ryun1/CIPs that referenced this pull request Nov 17, 2023
* draft language for common CIP element name + delimiter

* changed pipe char in table to use code tags + entity code

* reverting | to - for common subject delimiter

* minor change to make language more objective
rphair added a commit that referenced this pull request May 14, 2024
* CIP-???? | CIP-30 ext: Account public key

A [CIP-30 extension](https://cips.cardano.org/cips/cip30/#cardanowalletnameenableextensionsextensionpromiseapi) that allows for a DApp (if allowed) to fetch the connected account public key. Utilizes yet to-be-merged CIP-30 namespace PR #577.

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* standard form for copyright footer

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update according to #590

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* change delimiter character as per #594

* title delimiter changed to - as per #594 update

* assign CIP number 104

* Updates according to assigned CIP number

* updates according #601

* Move access line to spec section

---------

Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>
rphair added a commit that referenced this pull request May 28, 2024
* CIP-???? | CIP-30 ext: Bulk transaction signing

Replaces previous PR #443 by adopting CIP-30 extension framework as well as to-be-merged CIP-30 namespace PR #577.

* update api call to use cip namespace

* add checkboxes for items we're not sure are done yet

* word accuracy + grammar

* Mark criteria as completed

* include *all* prior GitHub discussion (2 PRs)

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update according to #590

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Update CIP-XXXX/README.md

Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>

* Addresses mentioned comments

* change delimiter character as per #594

* title delimiter changed to - as per #594 update

* assign CIP number 103

* Updates according to assigned CIP number

* Updates according to #601

* Update CIP-0103/README.md

Co-authored-by: Ryan <44342099+Ryun1@users.noreply.github.com>

* Update CIP-0103/README.md

Co-authored-by: Ryan <44342099+Ryun1@users.noreply.github.com>

* Update CIP-0103/README.md

Co-authored-by: Ryan <44342099+Ryun1@users.noreply.github.com>

---------

Co-authored-by: Robert Phair <rphair@cosd.com>
Co-authored-by: Ryan Williams <44342099+Ryun1@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Update Adds content or significantly reworks an existing proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants