Merge branch 'master' into v0.3.x

Signed-off-by: Håkon Wiik Ånes <[email protected]>

.github/pull_request_template.md

@@ -1,25 +1,23 @@
 #### Description of the change
 
-#### Progress of the PR
 
+#### Progress of the PR
 - [ ] [Docstrings for all functions](https://github.com/numpy/numpy/blob/master/doc/example.py)
 - [ ] Unit tests with pytest for all lines
 - [ ] Clean code style by [running black via pre-commit](https://kikuchipy.org/en/latest/contributing.html#code-style)
 
 #### Minimal example of the bug fix or new feature
-
 ```python
 >>> import kikuchipy as kp
->>> import numpy as np
->>> s = kp.signals.EBSD(np.zeros((10, 10, 10, 10)))
+>>> s = kp.data.nickel_ebsd_small()
+>>> s
+<EBSD, title: patterns My awes0m4 ..., dimensions: (3, 3|60, 60)>
 >>> # Your new feature...
 ```
 
 #### For reviewers
-
 <!-- Don't remove the checklist below. -->
-- [ ] Check that the PR title is short, concise, and will make sense 1 year
-  later.
-- [ ] Check that new functions are imported in corresponding `__init__.py`.
-- [ ] Check that new features, API changes, and deprecations are mentioned in
-      the unreleased section in `doc/changelog.rst`.
+- [ ] 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 `doc/changelog.rst`.

RELEASE.rst

@@ -1,26 +1,17 @@
 How to make a new release of ``kikuchipy``
 ==========================================
 
-This guide should be updated after every new release!
-
 - Create a release branch v<major>.<minor>.x. If a new minor release is to be
   made, branch off of master via the GitHub repo, and pull this branch locally.
   If a new patch release is to be made, pull the existing minor branch locally
   and branch off of it.
-
-- Review and clean up doc/changelog.rst as per Keep a Changelog. Make sure all
+- Review and clean up `doc/changelog.rst` as per Keep a Changelog. Make sure all
   contributors and reviewers are acknowledged. Increment the version number in
   `release.py`. Make a PR to the release branch.
-
 - Create a PR from the release branch to master. Discuss the changelog with
-  others, and make the changes directly to the release branch. After all checks
-  are green and the PR is merged, cherry-pick any resulting changes to the
-  release branch.
-
-- Make sure that the documentation, with the changelog updates, can be
-  successfully built from the release branch by making Read the Docs build the
-  release branch: https://readthedocs.org/projects/kikuchipy/.
-
+  others, and make the changes *directly* to the release branch. After all
+  checks pass the PR is merged, cherry-pick any resulting changes to the release
+  branch.
 - On the master branch, increment the version number in `release.py` to the next
   `.dev0`.
 - If a release candidate (RC) is to be made, make a PR to the release branch
@@ -33,27 +24,25 @@ This guide should be updated after every new release!
 - Create a release draft (tag) via the GitHub repo from the release branch with
   the correct tag version name, e.g. v0.42.x and release title (see previous
   releases). Add the new release notes from the changelog. Publish the release.
-
-- Monitor Travis CI to ensure the release is successfully published to PyPI.
+- Monitor the publish GitHub Action to ensure the release is successfully
+  published to PyPI.
+- Download the new version from PyPI with the `dev` dependencies locally and run
+  the tests to make sure everything is as it should be.
+- Make a PR to master with any updates to this guide if necessary.
 
 conda-forge
 -----------
-
 A kikuchipy build recipe is available at
 https://github.com/conda-forge/kikuchipy-feedstock. conda-forge documentation is
 available at https://conda-forge.org/docs/index.html.
 
 - Fork the feedstock.
-
 - Create a new release branch named v<major>.<minor>.x off of master.
-
 - Increment the version number in `recipe/meta.yml`. Get the SHA256 for the
   package distribution (`.tar.gz`) from PyPI
   https://pypi.org/project/kikuchipy/.
-
 - Make a PR to master from the release branch. Follow the relevant instructions
   from the conda-forge documentation on updating packages. Merge the PR after
   all checks are green.
-
 - Monitor the Azure pipeline CI to ensure the release is successfully published
   to conda-forge.