m

source/contribute/git.rst

@@ -11,11 +11,11 @@ git
    <div style="visibility: visible;">
 
 
-The *Carob* project is developed using the "git" versioning software. This greatly facilitates collaborative work and making incremental improvements because all changes made are tracked. A git project is called a "repo" (repository) and the "master" (main) Carob repo is `hosted on github <https::/github.com/reagro/carob>__ . 
+The *Carob* project is developed using the "git" versioning software. This greatly facilitates collaborative work and making incremental improvements because all changes made are tracked. A git project is called a "repo" (repository) and the "master" (main) Carob repo is `hosted on github <https::/github.com/reagro/carob>`__ . 
 
 To contribute to the *Carob* repo (and to other github based projects) you need to understand a few concepts and commands that we introduce here. 
 
-The first thing you need to do is create an account on github (other projects using git may use another platform such as bitbucket). Once you have an account, you can **fork** the *Carob* repo to your account. A fork is a copy of a git repo that you can make changes to while also getting any updates that are made to the main repo. 
+The first thing you need to do is create an account on `github <https::/github.com/reagro/carob>`__ if you do not have one (other projects using git may use another platform such as bitbucket for their git projects ). Once you have an account, you can **fork** the *Carob* repo to your account. A fork is a copy of a git repo that you can make changes to, while also getting any updates that are made to the main repo. 
 
 fork
 ----

source/contribute/index.rst

@@ -17,25 +17,25 @@ Contribute
 To contribute you can follow these steps
 
 
-1. Install the current version of *R*, and *git*. You can also install *R-Studio*.
-2. **install** `R` package "carobiner" with ``remotes::install_github("reagro/carobiner")``
+1. **Install** the current version of `R <https://cran.r-project.org/>`__ and `git <https://git-scm.com/downloads>`__. You can also install `R-Studio <https://posit.co/download/rstudio-desktop/>`__.
+2. In *R*, **install** the "carobiner" package with ``remotes::install_github("reagro/carobiner")`` (you may need to first run ``install.packages("remotes")``).
 3. **fork** the *Carob* `repo <https://github.com/reagro/carob/>`_ to your github account. 
 4. **clone** the forked repo to your computer.
-5. create a new `R` **script**, or make the changes to an existing script. See this `example <./example.html>`__ and the `guidelines <https://github.com/reagro/carob/wiki/Guidelines>`_).
+5. create a new `R` **script**, or make the changes to an existing script. See this `example <./example.html>`__ and the `guidelines <https://github.com/reagro/carob/wiki/Guidelines>`_.
 6. **check** your work by running ``carobiner::run_carob()`` for the new or changed `R` script.
 7. **sync** the forked repo with main repo in reagro/carob such that your fork is not behind.
 8. **add** and/or **commit** these changes to the forked repo on your github account.
 9. **push** your changes to the forked repo on your github account.
 10. create a **pull request** to integrate your changes into the main repo. Keep pull requests simple. They should normally consist of only one file at a time. 
 
-If you are not familiar with these procedures you can try to follow `these <./github.html>`__ instructions
+If you are not familiar with these procedures you can try to follow `these instructions <./github.html>`__. 
 
 If you find this procedure too daunting we can also try to work with you in other ways. You can drop us an email at [email protected], or raise an `issue <https://github.com/reagro/carob/issues>`_ on github.
 
 You can discover new data sets with the `Gardian <https://gardian.bigdata.cgiar.org>`_ search engine. You can also look at our to-do list below for ideas. You can check our `done list <done.html>`_ to make sure you do not work on a dataset that has already been processed). But since there can be a delay in updating what is shown here, before you start working on a dataset, you should check with ``carobiner::on_github`` if it has already been done (and has been added to the github repo). 
 
 .. raw:: html
-   :file: _R/todo.html
+   :file: ../_R/todo.html
 
 
 .. raw:: html