Skip to content

Re-organizing the top level #596

Description

@langestefan

Description

At the moment, I think repository instantiation creates too many files at the top level.

I just created a new repository using the template, and I got:

$ tree -s -h --du -L 1 -a -C --dirsfirst -r
[ 139K]  .
├── [   26]  .vscode
├── [  166]  test
├── [  156]  src
├── [  122]  .github
├── [  166]  .git
├── [   38]  examples
├── [  136]  docs
├── [   64]  .claude
├── [   34]  .yamllint.yml
├── [  218]  .yamlfmt.yml
├── [ 3.7K]  README.md
├── [  467]  Project.toml
├── [ 1.3K]  .pre-commit-config.yaml
├── [  228]  .markdownlint.json
├── [ 121K]  Manifest.toml
├── [  325]  .lychee.toml
├── [ 1.0K]  LICENSE
├── [  277]  .julia-startup.jl
├── [   55]  .JuliaFormatter.toml
├── [  149]  .gitignore
├── [  243]  .editorconfig
├── [  453]  .copier-answers.yml
├── [ 5.4K]  CODE_OF_CONDUCT.md
├── [  229]  codecov.yml
├── [ 2.1K]  CLAUDE.md
├── [  325]  CITATION.cff
└── [  127]  .all-contributorsrc

  139K used in 9 directories, 19 files

So at the top level we have 9 directories, and 19 files. I think this is too many. It makes it more difficult to find the item you're looking for, and the distance to the readme (to get the user interested) is too large.

Could we think about how to organize this better? For example, by moving some files into a separate folder?

Validation and testing

No response

Motivation

No response

Target audience

No response

Can you help?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    template: changeRelated to changes to the template, not the package - for new stuff, use 'addition to template'

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions