How to contribute to scikit-image — skimage 0.26.0 documentation

Developing open source software as part of a community is fun, and often quite educational!
We coordinate our work using GitHub, where you can find lists of open issues and new feature requests.
To follow along with discussions, or to get in touch with the developer team, please join us on the scikit-image developer forum and the Zulip chat.
Please post questions to these public forums (rather than contacting developers directly); that way, everyone can benefit from the answers, and developers can answer according to their availability. Don’t feel shy, the team is very friendly!
Divergence between upstream main and your feature branch
Stylistic Guidelines
Warnings during testing phase
Deprecation cycle (advanced)
Deprecating Keywords and Functions
Testing the benchmarks locally
Running your benchmark
Comparing results to main
The following is a brief overview about how changes to source code and documentation can be contributed to scikit-image.
If you are a first-time contributor:
Go to scikit-image/scikit-image and click the “fork” button to create your own copy of the project.
Set up GitHub SSH authentication.
Clone (download) the repository with the project source on your local computer:
Change into the root directory of the cloned repository:
Add your fork as a remote repository that you will interact with.
Assuming a GitHub username of codemonkey:
You now have two remote repositories:
upstream, which refers to the scikit-image project repository, and
codemonkey, which refers to your personal fork.
Next, set up your build environment.
Finally, we recommend that you use our pre-commit hook, which runs code checkers and formatters each time you do a git commit:
Develop your contribution:
Pull the latest changes from the project:
Create a branch for the feature you want to work on. Use a sensible name, such as ‘transform-speedups’:
Commit locally as you progress (with git add and git commit). Please write good commit messages.
To submit your contribution:
Push your changes back to your fork on GitHub:
A message will be displayed with a URL to open in your browser to create a pull request (PR). Open it and click the green button.
If you get stuck, reach out to us on our Zulip chat.
Reviewers (the other developers and interested community members) will write inline and/or general comments on your pull request (PR) to help you improve its implementation, documentation, and style. Every single developer working on the project has their code reviewed, and we’ve come to see it as a friendly conversation from which we all learn and the overall code quality benefits. Therefore, please don’t let the review discourage you from contributing: its only aim is to improve the quality of the project, not to criticize (we are, after all, very grateful for the time you’re putting in!).
To update your pull request, make your changes on your local repository and commit. As soon as those changes are pushed up (to the same branch as before) the pull request will update automatically.
Continuous integration (CI) services are triggered after each pull request submission to build the package, run unit tests, and check the coding style and formatting of your branch. The tests must pass before your PR can be merged. If CI fails, you can find out why by clicking on the “failed” icon (red cross) and inspecting the build and test logs.
CI will always fail on new PRs, until a maintainer adds a suitable category label.
A pull request must be approved by two core team members before merging.
If your change introduces a deprecation, add a reminder to TODO.txt for the team to remove the deprecated functionality in the future.
scikit-image uses changelist to generate a list of release notes automatically from pull requests. By default, changelist will use the title of a pull request and its GitHub labels to sort it into the appropriate section. However, for more complex changes, we encourage you to describe them in more detail using the release-note code block within the pull request description; e.g.: