Put together repository template

[TeresiaOlsson]

We have discussed to put together a repository template. See discussion #7. Someone should start putting this together so we can start using it.

[gubaidulinvadim]

It was discussed in one of the maintainers' meetings that Martin Gaughran will write to us when he has the time to prepare a short presentation of the DIAMOND template. Perhaps, we can re-ask him again @MJGaughran?

[MJGaughran]

I was waiting for the copier template to adopt uv before I advertised it for pyAML use, but I was also not thinking of a presentation!

I've had a chat with Tom, and we're hoping to get that PR merged in the next month or so. Since this template is in use by a large number of projects, it is important to properly test things before rolling out changes.

Is it reasonable for me to give an overview then? Otherwise, I can give a brief overview of what the template does in a couple of weeks, but some of the commands may end up changing when you try it out for yourselves.

[gubaidulinvadim]

I'm sorry, I must've misunderstood you. Yes, I think it would be good if you give an overview, so we can adopt the template.

[TeresiaOlsson]

Maybe even a little demonstration if you have time? I think there are many maintainers who have never used tools like linting and pre-commit so it could be useful for them to see how a workflow including that looks like.

It also sounded like you can apply the template to already existing repositories? Is that what you do at Diamond when you update the template? I'm curious how much trouble that causes and how much work it requires to update all repositories to follow the latest version.

[MJGaughran]

If you want to adopt the latest version, you just need to run:

copier update

and handle any merge conflicts. You can also provide any updated template settings, and pressing Enter will skip through and use your previous answers.

Yes, you can adopt the template on existing projects, although I haven't done much of that myself. It might be problematic if your repository is not structured like a 'typical' Python project, but it would probably just be a very messy merge.

After you've done the merge, though, you only need to run copier update occassionally.