I notice that we've become a bit lax at writing proper commit messages. Especially with squash merges, it is now common to see in the long list of items like "polish things up a bit" and "more verbose".
What do you think is the best way of handling this?
Perhaps we should copy the PR description into the commit message, instead of having a list of random gibberish? Or maybe the first commit should have a detailed description, and then we simply cut the rest of the items from that list?
We are aiming to release scikit-image 1.0 near the end of the year. We are, however, planning to make a number of breaking changes in the API that will affect downstream libraries. We have published a proposal for how we plan to do this at https://bit.ly/skip-3. The gist of it is:
- we'll release 0.19 in the coming weeks.
- we'll release 0.20 immediately after, which will be exactly the same but with a warning to pin scikit-image to `<0.20` (for those that want to stay in 0.x land indefinitely) or `!=0.20.*` (for those that want to be "on the ball" when 1.0 is released and update their code as soon as possible).
- we'll publish a transition guide along with 1.0rc0, and maintain 0.19.x with bug fixes for another year to give users time to transition.
The document describes alternative approaches ("change the wheels on the bus while still driving it" or "make a new bus with a new name") and why the core team ultimately chose to promote the current approach. Nonetheless, scikit-image is committed to being a community-led project, so we are still gathering feedback and can make substantive modifications to the plan going forward. Please don't hesitate to voice your concerns so we can make the best choice for our entire community going forward!
I'm interested in contributing to scikit-image but I am new to scientific
programming. I studied physics in undergrad and have a minor in
bioinformatics. As a result, I'm familiar with oop, data structures, and
algorithms. I'd like some mentorship to get started on actually developing
/ contributing code. I'm interested in image processing for structural
biology applications, and sometimes in my spare time I write scripts for my
current company. However, it is not production-grade, and it is quite
hacky. I'm hoping that through contributing to scikit-image, in whatever
way possible, I can gain some skills and give back in parallel.
According to the scikit-image website, mentoring is available and it seems
like contributing to open source is encouraged. Would anyone be interested
in mentoring me?
Thank you for your time,