Tidy up the versioning section a bit #64
Conversation
Put the examples and rationales next to the guidelines, fix a few typos. Thanks to @dndales for feedback.
|
|
||
| A set of packages defined in the same source repository MUST include version bounds which are as tight as necessary to ensure that they function correctly when distributed via a package repository. | ||
| Typically this will mean pinning the major version. | ||
| #### Rationale |
There was a problem hiding this comment.
I love this Principle; Example; Rationale sequence. It helps me understand the why's and how much better ❤️
| **Cardano dependencies** | ||
|
|
||
| Cardano packages themselves typically both a) make frequent breaking changes and b) have important behavioural differences between major versions. | ||
| However, Cardano packages themselves typically both a) make frequent breaking changes and b) have important behavioural differences between major versions. |
| ### Intra-repository dependencies | ||
|
|
||
| A set of packages defined in the same source repository MUST include version bounds which are as tight as necessary to ensure that they function correctly when [distributed](./distribution.md) via a package repository. | ||
| It is not possible to give a fully-general rule for what bounds to use, but assuming that the packages are following something like PVP, typically pinning the major version is the right thing to do. |
There was a problem hiding this comment.
I don't know if this belongs here, but why not require then that all packages in the same repo depend on an exact version of packages on that repo?
There was a problem hiding this comment.
We don't want to require too much work of people. For example, if you do a patch release of A, it would be nice to not also have to release B just to change the very-precise bound of B on A. If your follow PVP then a major version bound should be appropriate anyway.
There was a problem hiding this comment.
But I think the best practice here is not obvious and I'm very open to arguments for different policies!
Put the examples and rationales next to the guidelines, fix a few typos.
Thanks to @dndales for feedback.