Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply BestieTemplate.jl #676

Open
abelsiqueira opened this issue Jun 27, 2024 · 2 comments · May be fixed by #848
Open

Apply BestieTemplate.jl #676

abelsiqueira opened this issue Jun 27, 2024 · 2 comments · May be fixed by #848
Labels
Type: improvement Better way of doing something Zone: setup/admin Technical stuff that makes it work

Comments

@abelsiqueira
Copy link
Member

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

@clizbe
Copy link
Member

clizbe commented Jul 22, 2024

Sounds good to me. Of course you're biased, but so far drinking your Kool-Aid has worked out well for us. :)

What do you mean by the README.dev and CONTRIBUTING files moved to the docs?

@abelsiqueira
Copy link
Member Author

Thought I answered this. To keep the docs as the main information center of the package, we create two files in the docs: contributing.md and developer.md. These serve as CONTRIBUTING.md and README.dev.md. To avoid duplication, we keep only the files in the docs.

abelsiqueira added a commit to abelsiqueira/TulipaEnergyModel.jl that referenced this issue Oct 9, 2024
@abelsiqueira abelsiqueira linked a pull request Oct 9, 2024 that will close this issue
4 tasks
abelsiqueira added a commit to abelsiqueira/TulipaEnergyModel.jl that referenced this issue Oct 9, 2024
abelsiqueira added a commit to abelsiqueira/TulipaEnergyModel.jl that referenced this issue Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: improvement Better way of doing something Zone: setup/admin Technical stuff that makes it work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants