We should add a changelog that we can use to document all of the changes we're making to support the 2024 release. We can also use it in the future to document changes for upcoming releases. The changelog should be organized by version number, with the following sections for each version:
- Breaking changes
- This section should describe any changes that require users to update their legacy code (e.g. removed or changed column names)
- Improvements
- This section should describe changes that don't require updating legacy code, but that users might want to take advantage of (e.g. adding new optional keyword arguments to the
tax_bill() function)
- Bug fixes
- This section should describe any bugs we fixed
- Bug fixes usually don't require users to update any code, but it's sometimes useful for external users to know about them, in case they've encountered the bug in the past
For this specific release, it might also be helpful to add an image of the database diagram, with new or changed columns/tables highlighted. I suspect this will be a helpful aid given that we're changing the data model so much as part of this release.
We should add a changelog that we can use to document all of the changes we're making to support the 2024 release. We can also use it in the future to document changes for upcoming releases. The changelog should be organized by version number, with the following sections for each version:
tax_bill()function)For this specific release, it might also be helpful to add an image of the database diagram, with new or changed columns/tables highlighted. I suspect this will be a helpful aid given that we're changing the data model so much as part of this release.