TulipaEnergy / TulipaEnergyModel.jl

An energy system optimization model that is flexible, computationally efficient, and academically robust.
Apache License 2.0
17 stars 18 forks source link

Apply BestieTemplate.jl #676

Open abelsiqueira opened 4 days ago

abelsiqueira commented 4 days ago

What and Why

The BestieTemplate.jl was created using the best practices that we introduced in this package, so for many parts, this package is up-to-date in those practices. However, since it was created, there were improvements in the BestieTemplate that we should apply here and the easier way to do it is by adopting the template.

The template was applied to TulipaIO recently (in two parts, check the merged PRs). It was named COPIERTemplate.jl at the moment.

Some of the things:

If we do decide to apply it, we should wait until at least Monday, when the Registration of the rename will be done.

Possible Drawbacks

There are different choices, such as the issue and PR templates are different, the formatting is slightly different, and the README.dev and CONTRIBUTING files moved to the docs.

It takes some time to apply it the first time, since you have to fix the conflicts (though I can help with that).

I am biased, since I'm lead on the project.

Related Issues

No response