Contributing Guide¶
We welcome your contributions! Please see the provided steps below and never hesitate to contact us.
If you are a new user, we recommend checking out the detailed Github Guides.
Setting up a development installation¶
In order to make changes to napari, you will need to fork the
repository.
If you are not familiar with git, we recommend reading up on this guide.
Clone the forked repository to your local machine and change directories:
git clone https://github.com/your-username/napari.git
cd napari
Set the upstream remote to the base napari repository:
git remote add upstream https://github.com/napari/napari.git
Install the package in editable mode, along with all of the developer tools
pip install -r requirements.txt
We use pre-commit to sort imports with
isort, format code with
black, and lint with
flake8 automatically prior to each commit.
To minmize test errors when submitting pull requests, please install pre-commit
in your environment as follows:
pre-commit install
Upon committing, your code will be formatted according to our black
configuration, which includes the settings
skip-string-normalization = true and max-line-length = 79. To learn more,
see black’s documentation.
Code will also be linted to enforce the stylistic and logistical rules specified
in our flake8 configuration, which currently ignores
E203,
E501,
W503 and
C901. For information
on any specific flake8 error code, see the Flake8
Rules. You may also wish to refer to
the PEP 8 style guide.
If you wish to tell the linter to ignore a specific line use the # noqa
comment along with the specific error code (e.g. import sys # noqa: E402) but
please do not ignore errors lightly.
Adding icons¶
If you want to add a new icon to the app, make the icon in whatever program you
like and add it to napari/resources/icons/. Icons must be in .svg format.
Icons are automatically built into a Qt resource file that is imported when
napari is run. If you have changed the icons and would like to force a rebuild
of the resources, then you can either delete the autogenerated
napari/resources/_qt_resources*.py file, or you can set the
NAPARI_REBUILD_RESOURCES environmental variable to a truthy value, for
example:
export NAPARI_REBUILD_RESOURCES=1
Icons are typically used inside of one of our stylesheet.qss files, with the
{{ folder }} variable used to expand the current theme name.
QtDeleteButton {
image: url(":/themes/{{ folder }}/delete.svg");
}
Creating and testing themes¶
A theme is a set of colors used throughout napari. See, for example, the
builtin themes in napari/utils/theme.py. To make a new theme, create a new
dict with the same keys as one of the existing themes, and
replace the values with your new colors. For example
from napari.utils.theme import get_theme, register_theme
blue_theme = get_theme('dark')
blue_theme.update(
background='rgb(28, 31, 48)',
foreground='rgb(45, 52, 71)',
primary='rgb(80, 88, 108)',
current='rgb(184, 112, 0)',
)
register_theme('blue', blue_theme)
To test out the theme, use the
theme_sample.py file from the command line as follows:
python -m napari._qt.theme_sample
note: you may specify a theme with one additional argument on the command line:
python -m napari._qt.theme_sample dark
(providing no arguments will show all themes in theme.py)
Making changes¶
Create a new feature branch:
git checkout master -b your-branch-name
git will automatically detect changes to a repository.
You can view them with:
git status
Add and commit your changed files:
git add my-file-or-directory
git commit -m "my message"
Tests¶
We use unit tests, integration tests, and functional tests to ensure that napari works as intended. Writing tests for new code is a critical part of keeping napari maintainable as it grows.
We have dedicated documentation on testing that we recommend you read as you’re working on your first contribution.
Help us make sure it’s you¶
Each commit you make must have a GitHub-registered email
as the author. You can read more here.
To set it, use git config --global user.email your-address@example.com.
Keeping your branches up-to-date¶
Switch to the master branch:
git checkout master
Fetch changes and update master:
git pull upstream master --tags
This is shorthand for:
git fetch upstream master --tags
git merge upstream/master
Update your other branches:
git checkout your-branch-name
git merge master
Sharing your changes¶
Update your remote branch:
git push -u origin your-branch-name
You can then make a pull-request to napari’s master branch.
Building the docs¶
From the project root:
make docs
The docs will be built at docs/_build/html.
Most web browsers will allow you to preview HTML pages.
Try entering file:///absolute/path/to/napari/docs/_build/html/index.html in your address bar.
Code of conduct¶
napari has a Code of Conduct that should be honored by everyone who participates in the napari community.