DEEPDIP-project / CoupledNODE.jl

Apache License 2.0
2 stars 0 forks source link

Structure as a Julia package #8

Closed PabRod closed 4 months ago

PabRod commented 6 months ago

Side effect: from PkgTemplates perspective I am the only author.

PabRod commented 6 months ago

PkgTemplates.jl doesn't work with already existing code. More specifically, it requires an empty folder. My (suboptimal) workflow has been the following:

  1. Create a new, homonymous project on an empty folder.
  2. Manually copy-paste the folder structure and GitHub actions.

I strongly recommend starting all our future repositories directly from PkgTemplates.jl, so we can take advantage of its power.

This relates to our earlier conversation, @luisaforozco @SCiarella.

APJansen commented 6 months ago

I added and applied JuliaFormatter in PR #16, we could also add it in the CI, following something like this. But since that won't cause conflicts with other changes, I wanted to get the first part done ASAP.

APJansen commented 6 months ago

I can take up finishing this. Regarding formatting I propose using precommit to make sure everything that's committed is formatted properly, along with just a check in the CI, see also this comment. Do you agree with this approach @luisaforozco and @SCiarella?

Regarding releasing the docs as website, I'm not sure what exactly you had in mind @PabRod, or if you've already done something on that.

PabRod commented 6 months ago

Regarding releasing the docs as website, my two cents: