REL: 2.1.0

.github/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributions
+
+Contributions are welcome in the form of feedback and discussion in issues,
+or pull requests for changes to the code.
+
+Once the implementation of a piece of functionality is considered to be free of
+bugs and properly documented, it can be incorporated into the `main` branch.
+
+## Making a release on GitHub and PyPi
+
+`eeg_positions` is regularly released on
+[GitHub](https://github.com/sappelhoff/eeg_positions/releases)
+and
+[PyPI](https://pypi.org/project/eeg_positions/).
+
+Credentials are currently held by:
+
+- GitHub
+    - Admin
+      - [@sappelhoff](https://github.com/sappelhoff/)
+- PyPi
+    - Owner
+        - [@sappelhoff](https://github.com/sappelhoff/)
+
+Releasing on GitHub will automatically trigger a release on PyPi via a GitHub Action
+(The credentials for PyPi are stored as "GitHub Secrets").
+The release protocol can be briefly described as follows:
+
+1. You will need admin rights for the `eeg_positions` GitHub repository.
+1. Go to your Python environment for `eeg_positions`.
+1. Make sure all tests pass and the docs are built cleanly.
+1. Update the `__version__` variable in `__init__.py`:
+    - Remove the `.devN` suffix.
+    - If the version preceding the `.devN` suffix is not the version to be
+      released, update the version as well according to
+      [semantic versioning](https://semver.org/) with its `major.minor.patch`
+      style.
+1. If applicable, append new authors to the author metadata in the `CITATION.cff` file.
+1. Update `docs/changes.rst`, renaming the "current" headline to the new
+   version
+1. Commit the change and git push to `main` (or make a pull request and merge it).
+   Include "REL" in your commit message.
+1. Then, make an annotated tag `git tag -a -m "1.2.3" 1.2.3 upstream/main` (This
+   assumes that you have a git remote configured with the name "upstream" and
+   pointing to https://github.com/bids-standard/pybv).
+   **NOTE: Make sure you have your `main` branch up to date for this step!**
+1. `git push --follow-tags upstream`
+1. Make a [release on GitHub](https://help.github.com/en/articles/creating-releases),
+   using the git tag from the previous step (e.g., `1.2.3`).
+   Fill the tag name into the "Release title" field, and fill the "Description" field
+   as you see fit.
+1. This will trigger a GitHub Action that will build the package and release it to PyPi.
+
+Then the release is done and `main` has to be prepared for development of
+the next release:
+
+1. Update the `__version__` variable in `__init__.py`:
+    - Bump up the `major.minor.patch` version according to
+      [semantic versioning](https://semver.org/) so that the version will be
+      the version that is planned to be released next (e.g., `1.3.0`).
+    - Append `.dev0` to the version (e.g., `1.3.0.dev0`).
+        - (if you had a version like `1.3.0.dev0` before, release `1.3.0.dev1` instead, etc.)
+1. Add a "Current (unreleased)" headline to `docs/changes.rst`.
+1. Commit the changes and git push to `main` (or make a pull request).

docs/changes.rst

@@ -7,11 +7,12 @@ Changelog
 .. _Stefan Appelhoff: https://stefanappelhoff.com/
 .. _Clemens Brunner: https://github.com/cbrnr
 
-2.1.0 (unreleased)
+2.1.0 (2022-06-15)
 ------------------
 - Add a ``show_axis`` parameter to :func:`eeg_positions.plot_coords`, by `Clemens Brunner`_ (:github:`#7`)
 - Add a ``sort`` parameter to :func:`eeg_positions.get_coords`, by `Clemens Brunner`_ (:github:`#12`)
 - Allow passing a list of colors to :func:`eeg_positions.plot_coords`, by `Clemens Brunner`_ (:github:`#12`)
+- General maintenance and code review, by `Stefan Appelhoff`_
 
 2.0.0 (2021-02-13)
 ------------------

eeg_positions/__init__.py

@@ -1,6 +1,6 @@
 """Compute and plot standard EEG electrode positions."""
 
-__version__ = "2.1.0.dev0"
+__version__ = "2.1.0"
 
 
 from eeg_positions.compute import (