From a24abc18a152511013ad8fb26f10ff4c0d60f0c7 Mon Sep 17 00:00:00 2001 From: njlyon0 Date: Thu, 29 Feb 2024 10:36:58 -0500 Subject: [PATCH] Added an activity for making a README --- mod_reproducibility.qmd | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/mod_reproducibility.qmd b/mod_reproducibility.qmd index 6fac419..9487d30 100644 --- a/mod_reproducibility.qmd +++ b/mod_reproducibility.qmd @@ -55,6 +55,7 @@ With a partner discuss (some of) the following questions: - What--if any--limitations to your system have you experienced? - Do you think your structure would work well in a team environment? - If not, what changes might you make to better fit that context? + ::: #### Naming Tips @@ -194,6 +195,19 @@ Your project's README becomes the 'landing page' for those navigating your repos Finally, you should choose a place to keep track of ideas, conversations, and decisions about the project. While you can take notes on these topics on a piece of paper, adopting a digital equivalent is often helpful because you can much more easily search a lengthy document when it is machine readable. We will discuss GitHub during the [Version Control module](https://lter.github.io/ssecr/mod_version-control.html) but GitHub offers something called [Issues](https://nceas.github.io/scicomp-workshop-collaborative-coding/issues.html) that can be a really effective place to record some of this information. +:::{.callout-note icon="false"} +#### Activity: Create a README + +Create a draft README for one of your research projects. If all of your projects already have READMEs (very impressive!) revisit the one with the least detail. + +- Include a 2-4 sentence description of the project objectives / hypotheses +- Identify and describe (in 1 sentence) the primary sub-folders in the project +- If your chosen project includes scripts, summarize each and indicate which script(s) they depend on and which depend on them + +Feel free to put your personal flair on the README! If there is other information you feel would be relevant to an outsider looking at your project, you can definitely add that. + +::: + ### Organization Recommendations If you integrate any of the concepts we've covered above you will find the reproducibility and transparency of your project will greatly increase. However, if you'd like additional recommendations we've assembled a non-exhaustive set of _additional_ "best practices" that you may find helpful.