Skip to content

Commit bf7f079

Browse files
committed
comments
1 parent 197be1d commit bf7f079

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

doc/development/development.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are various ways to contribute to SpikeInterface as a user or developer. S
1313
* Crafting tutorials for common workflows (e.g., spike sorting, post-processing, etc.).
1414
* Writing unit tests to expand code coverage and use case scenarios.
1515
* Reporting bugs and issues.
16-
16+
o
1717
We use a forking workflow `<https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow>`_ to manage contributions. Here's a summary of the steps involved, with more details available in the provided link:
1818

1919
* Fork the SpikeInterface repository.
@@ -406,7 +406,7 @@ How to make a release
406406
Checklist
407407
^^^^^^^^^
408408
* pyproject.toml: check that the version is ahead of current release. Also, comment out the @ (git dependencies)
409-
* In the top level ``__init__`` uncomment ``DEV_MODE`` (this is used for the docker installations)
409+
* In the top level ``__init__`` (located on ``src/spikeinterface/__init__.py``) uncomment ``DEV_MODE`` (this is used for the docker installations)
410410
* Create a new release note for the appropriate version on doc/releases/new_version_tag.
411411

412412
There can be large releases like:
@@ -431,4 +431,10 @@ The signature of the script is:
431431
432432
Where the start date is the date of the last release and the end date is the current date.
433433

434-
The date of the last release can be found on PyPI.
434+
The date of the last release can be found on `PyPI <https://pypi.org/project/spikeinterface/>`_.
435+
436+
437+
As an specific example:
438+
.. code-block:: bash
439+
440+
bash auto-release-notes.sh 2025-02-19 2025-03-24

0 commit comments

Comments
 (0)