How to structure the files in your software project

[shoaibsufi]

To create a task page titled - 'How to structure the files in your software project' - this is from the prioritised list of pages people would like from the Jan WP2 and TF1 meetings - you can see the list in the spreadsheet - https://docs.google.com/spreadsheets/d/1TMzE5umQ2rkS9POAmhlAPNptBKin4eC3YW3YbijGci4/edit?gid=0#gid=0

Please

• look at the Contributing Guidelines which are linked from this page - https://everse.software/RSQKit/contributing_content
• In general make a branch or fork of the repo and do a pull request when your page is ready and please reference this Github issue

[jmaassen]

Isn't this very language / build system / framework specific? While it's good to adhere to the 'standard' there are many to choose from ;-)

[shoaibsufi]

From @egpbos - a useful reference - https://www.krajzewicz.de/blog/software-project-structure.php

and

https://www.wur.nl/en/value-creation-cooperation/partnerships-collaborations/wdcc-2/research-data-management-wdcc/doing/organising-files-and-folders.htm

[shoaibsufi]

Add general concepts and then give specifics examples based on context (language, build system and framework)

[shoaibsufi]

Maybe @jmaassen should be a reviewer for this one

[egpbos]

Also a separate folder for notebooks, tutorials, demos, etc. is common and useful (otherwise it gets hidden somewhere in src or code).

[graeme-a-stewart]

Shouldn't we give links to language specific documentation on this? I am not sure how useful general advice is. I don't care much how Python structures projects if I am writing a Julia package?

[stranak]

Hi, this tool is mentioned on the https://rdmkit.elixir-europe.org/licensing page, but you decided not to link to it in RSQKit: https://github.com/ufal/public-license-selector

I am just curious, do you find the "guided approach" less efficient than describing everything in a long(ish) text?

We are the developers of the guide, and we are very happy to improve it if you think some important part, or notice, or a decision point is missing, and therefore you find it unsuitable.

Just wanted to put it forward, because I think that overall the content of our tool and this page is 95% the same.