abelsiqueira / BestieTemplate.jl

Template for Julia Programming Language packages using the copier engine.
http://abelsiqueira.com/BestieTemplate.jl/
Mozilla Public License 2.0
37 stars 8 forks source link

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

Open tmigot opened 2 months ago

tmigot commented 2 months ago

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 commented 2 months ago

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

abelsiqueira commented 1 month ago

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:

cf. @lyashevska