- Docstrings for all functions
- Unit tests with pytest for all lines
- Clean code style by running black via pre-commit
>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()
>>> s
<EBSD, title: patterns My awes0m4 ..., dimensions: (3, 3|60, 60)>
>>> # Your new feature...
- The PR title is short, concise, and will make sense 1 year later.
- New functions are imported in corresponding
__init__.py
. - New features, API changes, and deprecations are mentioned in the unreleased
section in
CHANGELOG.rst
. - New contributors are added to .all-contributorsrc and the table is regenerated.