updating contributing

contributing.qmd

@@ -6,6 +6,8 @@ title: "Contributing"
 
 We always welcome contributions! Please note that we follow the [WILDS contributor guide](https://getwilds.org/guide/) in terms of reviewing contributions. 
 
+What makes a good snack? A good snack is about something that makes your day to day life easier. This could be a single function, or an entire package.
+
 ## Set Up Quarto
 
 We're using RStudio to build the website, but you can also work in Visual Studio Code or other IDEs.
@@ -14,14 +16,37 @@ Follow the instructions to set up Quarto for your IDE at [quarto.org](https://qu
 
 ## Fork Our Repo to Add a Snack
 
-You'll want to fork the `data_snacks` repository to get started: <https://github.com/fhdsl/data_snacks/>
+You'll want to fork the `data_snacks` repository to get started: <https://github.com/fhdsl/data_snacks/>.
+
+Then create a branch with your edits.
 
 ## R Snack Template
 
-[An example of an R Snack is here](https://github.com/fhdsl/data_snacks/blob/main/snack_template.qmd).
+[An example of an R Snack is here](https://github.com/fhdsl/data_snacks/blob/main/snack_template.qmd). Copy this into the `r_snacks/` folder to get started.
+
+Add a preview image in `/r_snacks/images/` to make your post more enticing, and then add it to the `image: ` field in your snack. For example, if your image is `/r_snacks/images/my_plot.png`, then the front matter should look like this:
 
-Add a preview image in `/r_snacks/images/` to make your post more enticing.
+```
+---
+title: My Cool Snack
+image: images/my_plot.png
+[...]
+---
+```
 
 ## Python Snack Template
 
-An example of a Python Snack is here. 
+An example of a Python Snack is here. 
+
+Add a preview image in `/python_snacks/images/` to make your post more enticing.
+
+## Make Sure the Site Builds
+
+In your folder, run:
+
+```
+quarto preview . 
+```
+
+## Make a Pull Request
+

docs/contributing.html

@@ -142,7 +142,8 @@ <h2 class="anchored" data-anchor-id="set-up-quarto">Set Up Quarto</h2>
 </section>
 <section id="fork-our-repo-to-add-a-snack" class="level2">
 <h2 class="anchored" data-anchor-id="fork-our-repo-to-add-a-snack">Fork Our Repo to Add a Snack</h2>
-<p>You’ll want to fork the <code>data_snacks</code> repository to get started: <a href="https://github.com/fhdsl/data_snacks/" class="uri">https://github.com/fhdsl/data_snacks/</a></p>
+<p>You’ll want to fork the <code>data_snacks</code> repository to get started: <a href="https://github.com/fhdsl/data_snacks/" class="uri">https://github.com/fhdsl/data_snacks/</a>.</p>
+<p>Then create a branch with your edits.</p>
 </section>
 <section id="r-snack-template" class="level2">
 <h2 class="anchored" data-anchor-id="r-snack-template">R Snack Template</h2>
@@ -152,6 +153,14 @@ <h2 class="anchored" data-anchor-id="r-snack-template">R Snack Template</h2>
 <section id="python-snack-template" class="level2">
 <h2 class="anchored" data-anchor-id="python-snack-template">Python Snack Template</h2>
 <p>An example of a Python Snack is here.</p>
+</section>
+<section id="make-sure-the-site-builds" class="level2">
+<h2 class="anchored" data-anchor-id="make-sure-the-site-builds">Make Sure the Site Builds</h2>
+<p>In your folder, run:</p>
+<pre><code>quarto preview . </code></pre>
+</section>
+<section id="make-a-pull-request" class="level2">
+<h2 class="anchored" data-anchor-id="make-a-pull-request">Make a Pull Request</h2>
 
 
 </section>

docs/search.json

@@ -109,7 +109,7 @@
     "href": "contributing.html#fork-our-repo-to-add-a-snack",
     "title": "Contributing",
     "section": "Fork Our Repo to Add a Snack",
-    "text": "Fork Our Repo to Add a Snack\nYou’ll want to fork the data_snacks repository to get started: https://github.com/fhdsl/data_snacks/"
+    "text": "Fork Our Repo to Add a Snack\nYou’ll want to fork the data_snacks repository to get started: https://github.com/fhdsl/data_snacks/.\nThen create a branch with your edits."
   },
   {
     "objectID": "contributing.html#r-snack-template",
@@ -236,5 +236,19 @@
     "title": "What’s Missing with {naniar}",
     "section": "In Conclusion: We Miss You, Missing Values",
     "text": "In Conclusion: We Miss You, Missing Values\nI’ve barely scratched the surface of all you can do with {naniar}. Nick has come up with all sorts of visualizations to address issues with missing values. I especially like the visualizations he’s added around imputations, which is one way to address missing values. Check his package out!"
+  },
+  {
+    "objectID": "contributing.html#make-sure-the-site-builds",
+    "href": "contributing.html#make-sure-the-site-builds",
+    "title": "Contributing",
+    "section": "Make Sure the Site Builds",
+    "text": "Make Sure the Site Builds\nIn your folder, run:\nquarto preview ."
+  },
+  {
+    "objectID": "contributing.html#make-a-pull-request",
+    "href": "contributing.html#make-a-pull-request",
+    "title": "Contributing",
+    "section": "Make a Pull Request",
+    "text": "Make a Pull Request"
   }
 ]