search

gwastro / BBHX-waveform-model

GNU General Public License v3.0
1 stars 3 forks source link

Add a changelog #12

Open mj-will opened 1 month ago

mj-will commented 1 month ago

It would be useful to have a changelog to log breaking changes, such as the TDI change.

WuShichao commented 1 month ago

Yeah, how to do that? Make a new release and change the log with it?

WuShichao commented 1 month ago

I also noticed that you changed the approx name: BBHX_PhenomD to BBHX_IMRPhenomD. This will break PyCBC PE example.

WuShichao commented 1 month ago

I will create a PR to change the name back, otherwise I need to change the name in PyCBC PE example and last week's LISA demo.

mj-will commented 1 month ago

I also noticed that you changed the approx name: BBHX_PhenomD to BBHX_IMRPhenomD. This will break PyCBC PE example.

Yes, this wasn't intentional and I think the change was introduced in https://github.com/gwastro/BBHX-waveform-model/pull/2 and then I copied it over. I'll add a test for this to avoid this in future.

mj-will commented 1 month ago

I realised PyCBC doesn't have a changelog either, so it's debatable whether this package needs one. If you were to add one, I'd follow some sort of standard, e.g. https://keepachangelog.com/en/1.1.0/