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.

Sign up for GitHub

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

Jump to bottom

Add somewhere that the files have been generated by BestieTemplate #282

Open
tmigot opened this issue Jun 21, 2024 · 2 comments · May be fixed by #305
Open

Add somewhere that the files have been generated by BestieTemplate #282

tmigot opened this issue Jun 21, 2024 · 2 comments · May be fixed by #305
Assignees
@lyashevska
Labels
chore good first issue Good for newcomers usage docs Related to documentation on how to use the package or template

Comments

@tmigot
Copy link
Contributor

tmigot commented Jun 21, 2024

Description

It would be great to have written somewhere in my package using COPIERTemplate that it uses COPIERTemplate.

Motivation

The motivation is to detect quickly that a change to CI files in my package using COPIERTemplate should maybe have come through an update of COPIERTemplate.

Target audience

Contributors/developers that are tempted to update files generated by COPIERTemplate

Can you help

Yes!
@tmigot
Copy link
Contributor Author

tmigot commented Jun 21, 2024

One possible solution is to have a header in the generated files.

@abelsiqueira abelsiqueira added usage docs Related to documentation on how to use the package or template chore labels Jul 3, 2024
@abelsiqueira abelsiqueira added this to the 0.8.0 milestone Jul 3, 2024
@abelsiqueira abelsiqueira changed the title Add somewhere that the files have been generated by COPIERTemplate Add somewhere that the files have been generated by BestieTemplate Jul 3, 2024
@abelsiqueira abelsiqueira added the good first issue Good for newcomers label Jul 3, 2024
@lyashevska lyashevska self-assigned this Jul 3, 2024
@abelsiqueira
Copy link
Collaborator

One possible solution is to add a comment like

This file was created by BestieTemplate.jl. Create issues there: https://github.com/abelsiqueira/BestieTemplate.jl/issues

Some of the files that could have this:

  • workflow files
  • pre-commit and other configuration files
  • maybe docs/make.jl?

cf. @lyashevska

@lyashevska lyashevska linked a pull request Jul 3, 2024 that will close this issue
Open
5 tasks
@abelsiqueira abelsiqueira removed this from the JuliaCon milestone Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lyashevska lyashevska

Labels
chore good first issue Good for newcomers usage docs Related to documentation on how to use the package or template
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update headers with "This file was created by BestieTemplate.jl." JuliaBesties/BestieTemplate.jl
3 participants
@abelsiqueira @lyashevska @tmigot