Skip to content

Mixed use of the tools/ directory #703

@MakisH

Description

@MakisH

Our tools/ directory currently contains:

  • Tools meant to be copied by users when they want to extract a tutorial (e.g., log.sh)
  • Tools used by pre-commit (e.g., check-size.sh)
  • System tests related tools (tools/tests/)

This is rather confusing for users. I would suggest splitting this into:

  • tools/: Only for user-facing scripts
  • tests/: For the system tests

What do we then do with the scripts used by pre-commit? Alternatives:

  • checks/ (ugh)
  • pre-commit/ (clear for us, strange for someone that does not know what this is)
  • keep them in tools/, but maybe in a subdirectory tools/pre-commit?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions