Repo housekeeping ideas

[sujaypatil96]

This is a great improvement over the previously existing linkml-template repo @turbomam, thank you for this.

I had a few quick, trivial housekeeping suggestions I wanted to document in this issue:

• Transfer repo over to linkml org.
  • When you transfer the repo and possibly rename it, you probably shouldn't use the previous name, i.e., linkml-model-template since it might interfere with downstream repos which already use that version of the template
• Possible alternatives:
  • linkml-model-template-v2
  • ideas?
• Add CONTRIBUTING.md
  • for example https://github.com/pallets/flask/blob/main/CONTRIBUTING.rst
• Remove placeholder.txt from model folder
• Archive linkml-model-template repo

Pass on these for now?

Discussed at 2022-03-04 LinkML call. Can revisit if necessary.

• Move kitchen_sink.yaml into a subfolder called etc within model. So basically you'd have: model > etc > kitchen_sink.yaml
• core.yaml can either be in the top level model folder or in a sub folder called core

[cmungall]

Thanks!!!

linkml-model-template-v2

let's not do this. We can move the existing one to linkml-model-template-legacy.

We should have a single clear source of truth optio

[cmungall]

I renamed to https://github.com/linkml/linkml-project-template

[cmungall]

I now favor this layout:

• pyproject.toml
• about.yaml
• LICENSE
• README.md
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• src
  • linkml
    • my_project_name.yaml
  • my_project_name
    • datamodel
      * my_project_name.py
• generated
  • jsonschema
  • owl
  • linkml
  • shacl
  • ...etc

Made a start:

• Use src folder #4.

[cthoyt]

1. if you put CODE_OF_CONDUCT.md inside a .github folder, it gets picked up by GitHub
2. the datamodel/my_project_name.py seems redundant. Why not just datamodel.py or even better just models.py
3. Would suggest keeping the linkml folder inside src/my_project_name/ if you want it to get redistributed with the package