Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addition of a *bin* or *scripts* directory in episode 6. Project organization #347

Open
GeorgiaBreckell opened this issue Aug 11, 2023 · 1 comment

Comments

@GeorgiaBreckell
Copy link

How could the content be improved?

In episode 5 scripts are written and saved. I believe it is generally considered best practice to store these together in a specific directory. Could the creation of a bin directory be added to episode 6 to help introduce a more complete organisation structure?

Which part of the content does your suggestion apply to?

https://datacarpentry.org/shell-genomics/06-organization.html

@p-j-smith
Copy link
Contributor

Hi @GeorgiaBreckell, apologies for the slow response, and thanks for the suggestion! Just to clarify, are you referring to the scripts written in episode 5 or 6, or both?

I think in general it would make sense to have a scripts directory for your project. However, in episode 5 the best practices for project organisation haven't yet been introduced, and it may cause some confusion to discuss project structure in both this episode and episode 6.

And for episode 6, I think the only script that is created is the one that stores the history (the commands you've used to create your project). This script is currently in the parent directory of the project, rather than part of the project itself, i.e. it is not in the dc_workshop folder but rather dc_workshop/../. I think it makes sense to keep it here as it is not a part of the project per se but instead documents how the project was developed, and enables you to re-create the project if necessary.

So I think it is probably best to keep the current structure, but please let me know if there's something I'm missing or if I'm misunderstanding something!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants