JoshuaLampert / DispersiveShallowWater.jl

Structure-preserving numerical methods for dispersive shallow water models
https://joshualampert.github.io/DispersiveShallowWater.jl/
MIT License
15 stars 3 forks source link

prepare publication #137

Closed ranocha closed 1 month ago

ranocha commented 1 month ago

Since we're adding more features to this repo, it's getting more interest from others. Thus, it would be nice to polish it a bit - so that we can also prepare a software paper in the future. I have started this process in this PR.

@JoshuaLampert If you're fine with this, could you maybe list some breaking changes in the NEWS.md file?

JoshuaLampert commented 1 month ago

Thanks a lot for initiating that! I will fill the NEWS.md file with the changes from the last releases.

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 97.57%. Comparing base (935081c) to head (1a3aa96). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #137 +/- ## ======================================= Coverage 97.57% 97.57% ======================================= Files 20 20 Lines 1569 1569 ======================================= Hits 1531 1531 Misses 38 38 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JoshuaLampert commented 1 month ago

@JoshuaLampert If you're fine with this, could you maybe list some breaking changes in the NEWS.md file?

I filled the NEWS.md file. Please have a look if this looks fine to you.

ranocha commented 1 month ago

Let's see how the rendered changelog looks in the docs. If it's fine, I'm fine merging this PR

JoshuaLampert commented 1 month ago

The changelog looks nice, I think.

ranocha commented 1 month ago

I adapted the text in the code of conduct so that the links are better integrated in the markdown text.

ranocha commented 1 month ago

The changelog looks nice, I think.

I agree - nice work 👍