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

docs: sort/arrange directories #2

Closed
tusharnankani opened this issue Feb 7, 2022 · 3 comments
Closed

docs: sort/arrange directories #2

tusharnankani opened this issue Feb 7, 2022 · 3 comments

Comments

@tusharnankani
Copy link

While I was going through the code, the helper files, the notebooks, the data felt a bit scattered.

image

Suggestion:

You can create proper directories for all your files, then document them to explain your thought process around them.

Eg:

*
└───data
    ├───summaries
        └───*.md
    └───.*csv
└───util
    └───helper_file.ipynb
└───assets

Further, you can write your workflow. Which helper file you used, then where did you use that output in another helper file, so on and so forth?
Just a suggestion.

Really great project! So proud <3

@mihikagaonkar
Copy link
Owner

Thank you Tushar!

@tusharnankani
Copy link
Author

Love the changes. Looks clean, nice work :D

@tusharnankani
Copy link
Author

Here's a nice article around it: Colocation

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