search

AMICI-dev / AMICI

Advanced Multilanguage Interface to CVODES and IDAS
https://amici.readthedocs.io/
Other
108 stars 30 forks source link

Add deprecation policy #2465

Closed dweindl closed 3 months ago

dweindl commented 3 months ago

As suggested in https://github.com/AMICI-dev/AMICI/issues/2458.

Other opinions?

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.63%. Comparing base (043d13a) to head (f261219). Report is 24 commits behind head on develop.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/graphs/tree.svg?width=650&height=150&src=pr&token=1bt9lbspzk&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev)](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) ```diff @@ Coverage Diff @@ ## develop #2465 +/- ## ============================================ + Coverage 36.66% 77.63% +40.97% ============================================ Files 103 324 +221 Lines 14881 20927 +6046 Branches 1388 1464 +76 ============================================ + Hits 5456 16247 +10791 + Misses 9116 4677 -4439 + Partials 309 3 -306 ``` | [Flag](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `73.39% <ø> (?)` | | | [cpp_python](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `34.09% <ø> (?)` | | | [petab](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `36.66% <ø> (ø)` | | | [python](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev) | `72.18% <ø> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev#carryforward-flags-in-the-pull-request-comment) to find out more. [see 289 files with indirect coverage changes](https://app.codecov.io/gh/AMICI-dev/AMICI/pull/2465/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=AMICI-dev)
dweindl commented 3 months ago

could also add this outside of the changelog, e.g. https://amici.readthedocs.io/en/latest/development.html

Yes, I wasn't sure where to put it. That document says This document contains information for AMICI developers, not too relevant to regular users., so I don't think it's the right place. In the changelog it's the most visible, but I can also add a separate document on versioning, deprecation, ... policy.