Issues when creating new project

[AlexanderWells-diamond]

Here's a list of bits and pieces I encountered when creating a new project from scratch:

• In "create-new" the current command copier copy gh:DiamondLightSource/python-copier-template /path/to/my-project needs --trust added to it, the same as is present on the main README

• It's confusing if you try and create a project with a hypen or dash in the name - the various fields will auto-correct themselves to make the names compliant with the relevant specs for each question, but it feels like there should be something to suggest what should be done in this case

• The "Upload to GitHub" section doesn't work as is, as there are no commits in the repository. The instructions should either explicitly say to do an initial commit, or the copier template should have done it automatically

• When trying to do a commit I see the error pre-commit configuration detected, butpre-commit installwas never run.

• When trying to install pre-commit, "ruff" is not found. I think the summary is that you need to install the entire project (including dev dependencies) before doing an initial commit?

  • I had an additional issue where the pre-commit was causing commits to become impossible to do. The symptom was that during commits I saw the below pre-commit message, and all commits would fail. The fix was to run pre-commit install -f to do a forced install and override some legacy config somewhere.

    git commit -m "initial commit"
    pre-commit configuration detected, but `pre-commit install` was never run
    check for added large files..............................................Passed
    check yaml...............................................................Passed
    check for merge conflicts................................................Passed
    lint with ruff...........................................................Passed
    format with ruff.........................................................Passed
    (venv) [eyh46967@pc0103 psc-datalogger]$ git log
    fatal: your current branch 'main' does not have any commits yet

• The Project Description is not edited through the Settings menu, it's done from the cogwheel on the main page next to the "About" header

[AlexanderWells-diamond]

Additionally, it may be worth adding a link somewhere to the Podman fix that I also had to run: https://dev-portal.diamond.ac.uk/guide/containers/tutorials/podman/#enable-use-of-vscode-features

[coretl]

I couldn't reproduce the pre-commit failure, and I don't understand how it got pre-commit configuration detected, but pre-commit install was never run. How did the commit hook get added if not by running pre-commit install? Do you have something like https://pre-commit.com/#pre-commit-init-templatedir ?

[AlexanderWells-diamond]

I don't think I ever set that up, but as mentioned in my list of problems I did have to do a forced override of some pre-commit cache somewhere, so perhaps that whole section of problems is just a me thing.