search

dtr-org / unit-e-project

Unit-e project information
MIT License
13 stars 4 forks source link

ADR-23: Unit-e Improvement Proposal #81

Closed cornelius closed 5 years ago

cornelius commented 5 years ago

This is the result of the discussions we had about ADRs and introducing a new process for design decisions on the protocol level. See the document for details.

cornelius commented 5 years ago

I think this has been subject to a lot of discussion and confusion. I would very much welcome examples, as I feel that people learn best from examples and illustration. It certainly helps understanding and clarification.

That's a very good point. From your point of view, what are good examples in the ADRs we have right now, or can you think of any other good examples somewhere else?

cornelius commented 5 years ago

Sketch for UIP-1 as reference: https://github.com/dtr-org/unit-e-docs/pull/83

scravy commented 5 years ago

BTW, when was the out-of-date thing check enabled for unit-e-docs? One the one hand I like to require uptodateness, but on the other hand if it's not conflicting (in that case it would not allow you merging anyhow as it would not know how) then I do not see any harm in having it slightly out of date (most likely something else was changed and since this is not actually code with mutually dependent compilation units it does not matter).

cornelius commented 5 years ago

BTW, when was the out-of-date thing check enabled for unit-e-docs? One the one hand I like to require uptodateness, but on the other hand if it's not conflicting (in that case it would not allow you merging anyhow as it would not know how) then I do not see any harm in having it slightly out of date (most likely something else was changed and since this is not actually code with mutually dependent compilation units it does not matter).

Not sure, if it was an explicit decision to enable it. Maybe it is just the default to have it enabled. I agree with your reasoning, if it's not code and we don't have CI for code, we probably don't need the up-to-date check. I disabled it now, let's see how this goes.

cornelius commented 5 years ago

This is the draft for the PR which would implement this decision on the ADR side: https://github.com/dtr-org/unit-e-docs/pull/84

cornelius commented 5 years ago

I think we have addressed all open questions regarding this particular ADR. There are still some things to be made more concrete for the UIP, but this is out of scope of this ADR, this will be part of UIP-1. So it would be great if we can get some buy-in in form of approvals for this ADR.