Update development practices#734
Update development practices#734dstansby merged 1 commit intozarr-developers:mainfrom dstansby:update-dev-guide
Conversation
| changes. | ||
|
|
||
| When making a minor release, open an issue stating your intention so other developers | ||
| know that a release is planned. At least a week's notice should be given for other |
There was a problem hiding this comment.
| know that a release is planned. At least a week's notice should be given for other | |
| know that a release is planned. In most cases, at least a week's notice should be given for other |
There was a problem hiding this comment.
I'm reluctant to un-tighten the language here - I think for minor releases (as opposed to micro releases with bugfixes) a week's notice is reasonable?
There was a problem hiding this comment.
I find these sorts of black/white constraints to introduce unnecessary friction. We don't want to get into a place where a minor release needs to go out but someone objects to its release because the announcement was only 5 days prior. I'm looking for directional guidance here, not hard and fast rules.
There was a problem hiding this comment.
I think "should be given" already indicates that almost always it should be respected, but there's room in exceptional circumstances to bypass the reccomendation? At least that's the existing language in this document, and it's not prefaced by "in most cases" elsewhere.
|
Thanks @dstansby for opening this up. A few other observations that we may want to address here or elsewhere:
cc @zarr-developers/python-core-devs A note about yesterday's release. It was a bit of a bummer to have a breaking release in numcodecs force a release in zarr-python. That said, it wasn't that big of a disruption and is something that we can hopefully use to motivate improvements in our process here. Much better to learn our lesson on relatively inconsequential mistakes than on big ones! |
|
broadly speaking I think the dev tooling in numcodecs could use some love. see #697. I have been satisfied with everything we are doing over in zarr-python w.r.t. CI and the developer environment. Copying that to numcodecs wherever possible would probably be a good use of effort. |
|
Given this has an approval and has been open for a while, I'll merge. Further suggestions/updates to this definitely welcome in follow up PRs! |
This updates development practices to: