add contributing guidelines

juanitorduz · Jul 12, 2020 · 4dceb0a · 4dceb0a
1 parent dbaaca6
commit 4dceb0a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+# Contributing 
+
+We highly encourage to contribute to this repository! 
+
+- If you find and error or have a specific request you can create an [Issue](https://guides.github.com/features/issues/).
+- Add an analysis/experiment using a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). Please add your code into the corresponding folder `R/experiments` or `python/experiments`.
+- If you want to add your code regarding a specific meet-up, please included in a folder with the corresponding date `<YEAR>-<MONTH>`. For example, if you want to add a python notebook `my_notebook.ipynb` (you can add your name, or any tag representing you into the file name) for the meetup of August 11th 2020 then just include it in `python/2020-08/my_notebook.ipynb`. Then create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
diff --git a/README.md b/README.md
@@ -63,11 +63,4 @@ From the root directory type R and hit enter. Then type `renv::restore()` and re
 
 #### Option 2: From [RStudio](https://rstudio.com/)
 Open an Rstudio session. Go to `RStudio > 'Open Project in New Session'`. Navigate to the btsa folder and click open.
-In the console, type `renv::restore()` to install the necessary packages. Your RStudio session is now configured.
-
----
-## Contributing 
-We highly encourage to contribute to this repository! 
-  - If you want to add your code regarding a specific meet-up, please included in a folder with the corresponding date `<YEAR>-<MONTH>`. For example, if you want to add a python notebook `my_notebook.ipynb` (you can add your name, or any tag representing you into the file name) for the meetup of August 11th 2020 then just include it in `python/2020-08/my_notebook.ipynb`. Then create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
-  - If you find and error or have a specific request you can create an [Issue](https://guides.github.com/features/issues/).
-  - Add an analysis/experiment using a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests). 
+In the console, type `renv::restore()` to install the necessary packages. Your RStudio session is now configured.