Source code directory name `src`

rl-institut / super-repo

A template repo to test and document repo elements and features

https://rl-institut.github.io/super-repo/

MIT License

13 stars 0 forks source link

Source code directory name `src` #23

Closed jh-RLI closed 1 year ago

jh-RLI commented 1 year ago

Description of the issue

As it we discussed about the name of the source dir... the src is meant as placeholder for the actual module. It can include sub modules of course. But for some use cases its more clean to have a structure like module-name/... rather then src/module-name folder/... .

Ideas of solution

Rename folder

Workflow checklist

[x] I am aware of the workflow in CONTRIBUTING.md

Ludee commented 1 year ago

As discussed today we follow the Hitchhiker’s Guide to Python and remove the src folder.

Your library does not belong in an ambiguous src or python subdirectory.

source: https://docs.python-guide.org/writing/structure/#the-actual-module