Skip to content

Add how to make a release notes#3793

Merged
alejoe91 merged 13 commits intoSpikeInterface:mainfrom
h-mayorquin:add_how_to_make_a_release_notes
Apr 17, 2025
Merged

Add how to make a release notes#3793
alejoe91 merged 13 commits intoSpikeInterface:mainfrom
h-mayorquin:add_how_to_make_a_release_notes

Conversation

@h-mayorquin
Copy link
Copy Markdown
Collaborator

Draft

@h-mayorquin h-mayorquin added the documentation Improvements or additions to documentation label Mar 21, 2025
@h-mayorquin h-mayorquin self-assigned this Mar 21, 2025
Copy link
Copy Markdown
Member

@zm711 zm711 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a great idea!

Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
h-mayorquin and others added 2 commits March 21, 2025 12:14
Co-authored-by: Zach McKenzie <92116279+zm711@users.noreply.github.com>
Co-authored-by: Zach McKenzie <92116279+zm711@users.noreply.github.com>
Copy link
Copy Markdown
Member

@chrishalcrow chrishalcrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - a great idea! Just some little bits and pieces.

Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst
Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst
h-mayorquin and others added 3 commits March 24, 2025 10:17
Co-authored-by: Chris Halcrow <57948917+chrishalcrow@users.noreply.github.com>
Copy link
Copy Markdown
Member

@zm711 zm711 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is about ready for final review Heberto. But I guess there is no rush on it if you were thinking of something else :)

Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
Checklist
^^^^^^^^^
* pyproject.toml: check that the version is ahead of current release. Also, comment out the @ (git dependencies)
* In the top level ``__init__`` (located on ``src/spikeinterface/__init__.py``) uncomment ``DEV_MODE`` (this is used for the docker installations)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* In the top level ``__init__`` (located on ``src/spikeinterface/__init__.py``) uncomment ``DEV_MODE`` (this is used for the docker installations)
* In the top level ``__init__`` (located on ``src/spikeinterface/__init__.py``) uncomment ``DEV_MODE`` (this is used for the docker installations)

The dev_mode is completely clear because we have the two lines one with True and one with False. To be clear we should say to uncomment the DEV_MODE=False and to comment out the DEV_MODE=True

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't * sorry my typo.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

improved by Alessio somewhere down this thread.

Comment thread doc/development/development.rst Outdated
Co-authored-by: Zach McKenzie <92116279+zm711@users.noreply.github.com>
@h-mayorquin
Copy link
Copy Markdown
Collaborator Author

I think this is about ready for final review Heberto. But I guess there is no rush on it if you were thinking of something else :)

There is a release to be doing soon. I want to shadow @alejoe91 during it and after I will add more notes here.

@zm711
Copy link
Copy Markdown
Member

zm711 commented Apr 1, 2025

Sounds good to me!

Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
@h-mayorquin h-mayorquin marked this pull request as ready for review April 16, 2025 20:02
Comment thread doc/development/development.rst Outdated
Comment thread doc/development/development.rst Outdated
@alejoe91
Copy link
Copy Markdown
Member

Thanks @h-mayorquin

LGTM! Merging :)

@alejoe91 alejoe91 merged commit bea1b8e into SpikeInterface:main Apr 17, 2025
15 checks passed
@h-mayorquin h-mayorquin deleted the add_how_to_make_a_release_notes branch April 17, 2025 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants