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

010: thread spec #7

Merged
merged 20 commits into from
May 10, 2023
Merged

010: thread spec #7

merged 20 commits into from
May 10, 2023

Conversation

mixmix
Copy link
Member

@mixmix mixmix commented Mar 27, 2023

No description provided.

@mixmix
Copy link
Member Author

mixmix commented Mar 27, 2023

@mixmix mixmix changed the title add ssb-thread-spec 010: thread spec Mar 27, 2023
Copy link
Member

@staltz staltz left a comment

Choose a reason for hiding this comment

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

I like the mermaids. 🧜‍♀️

The document needs a little bit of structure, with abstract, specification, etc. Also we need to address those TODOs before merging. And I need to give it a read to make sure it's more prescriptive (telling readers what they should do to implement this SIP) than educational (giving readers a tour through threads world), with some MUSTs and SHOULDs.

010.md Outdated Show resolved Hide resolved
010.md Show resolved Hide resolved
010.md Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
010.md Show resolved Hide resolved
@mixmix
Copy link
Member Author

mixmix commented Mar 28, 2023

@staltz I want to do the minimal additional work to get this merged.

TODOs:

  • I don't know how forks are handled, or what the logic is because I didn't implement it. I don't think this should be held up on that
  • channels ... shrug, I don't have energy, but can point to the right code

Prescriptive vs. educational, yes keen to see that done.

Given I don't want to do much more work on this, but we need it written down somewhere, would you be down to pair on this to get it done?

010.md Outdated Show resolved Hide resolved
@staltz
Copy link
Member

staltz commented Mar 28, 2023

Given I don't want to do much more work on this, but we need it written down somewhere, would you be down to pair on this to get it done?

I'm your inverse, I feel less motivated when I'm pairing to get things done. I suggest we just relax the deadlines with this PR. You (or me) can come back to it some time in the future and finish the TODOs.

@ahdinosaur
Copy link

I don't know how forks are handled, or what the logic is because I didn't implement it. I don't think this should be held up on that

for what it's worth, thread forks should probably be a separate spec anyways.

@ahdinosaur ahdinosaur mentioned this pull request Mar 28, 2023
@mixmix
Copy link
Member Author

mixmix commented Mar 28, 2023

A wild @ahdinosaur appears! Hi <3
Yeah making it a different sip would feel nice ... or just not requiring it to be in here ...sigh

@staltz can we just merge this. It's better than nothing, and not having it in master means it's not really visible

@staltz
Copy link
Member

staltz commented Mar 29, 2023

@staltz can we just merge this. It's better than nothing, and not having it in master means it's not really visible

Nope! Let's please not push documents that have TODOs in them as official specification. If someone really wants to read something in progress, they can just open the "Pull Requests" tab and browse this.

It would also go against the REVIEWING.md which wasn't written in vain, so please don't merge things that are work in progress.

@mixmix
Copy link
Member Author

mixmix commented May 9, 2023

I want to remove forks from this spec, and merge it
Can we do that @staltz ?
I want to be able to link to this at a stable location

@mixmix
Copy link
Member Author

mixmix commented May 9, 2023

DONE - removed forks

@mixmix mixmix requested a review from staltz May 9, 2023 23:38
@staltz
Copy link
Member

staltz commented May 10, 2023

I'll take a look, thanks

Copy link
Member

@staltz staltz left a comment

Choose a reason for hiding this comment

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

Super sweet SIP. I like how it's complete: specifies msg schemas, specifies how the tangles works, how channels works, how content warnings work etc.

I have a few suggestions to fix before merging, nothing that requires you to write anything yourself, since I put the code suggestions inline. Mostly, there is some ambiguity with the notation [X] which could confuse some readers. That's the most important thing to fix.

Then, there's just a suggestion to relax some MUST to SHOULD.

That's all I have, and then feel free to merge.

010.md Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
010.md Outdated Show resolved Hide resolved
@mixmix mixmix merged commit 8f4909e into master May 10, 2023
@mixmix mixmix deleted the thread branch May 10, 2023 21:56
@mixmix
Copy link
Member Author

mixmix commented May 10, 2023

merge squashed!

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.

3 participants