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

Add templated README.md to subfolders #135

Open
eliocamp opened this issue Jan 8, 2021 · 2 comments
Open

Add templated README.md to subfolders #135

eliocamp opened this issue Jan 8, 2021 · 2 comments

Comments

@eliocamp
Copy link
Contributor

eliocamp commented Jan 8, 2021

Inspired by these awesome slides by Danielle Navarro, I was thinking that adding at least bare-bones README.md files to subfolders might nudge people in the right direction.

image

Specifically, I was thinking on the analysis folder and all its subfolders. For example, the data folder could have an explanation of what is in raw_data and derived_data.

@benmarwick
Copy link
Owner

Thank you for that very interesting suggestion! What could be good text to put in these readme? Some text that is very short, just a few sentences, that would suit a variety of different users would be ideal, I think. Would you like to draft the text of these in a post to this issue thread so we can discuss and revise further?

@wolass
Copy link
Contributor

wolass commented Jan 11, 2021

I think It could intertwine with issue #86.

If we decide on a more structured analysis we would automatically know how to guide people better by creating README or MAN pages or any other form of support for the analysis.

As I see it right now there is a gap between the paper writing process - which rrtools handles well, and the analysis process - which we assume the user of the package should do themselves and level them to it. In my opinion, we should assist in this initial step a bit more...

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

No branches or pull requests

3 participants