Skip to content

Commit d856bec

Browse files
committed
Add pointer to nice book for git newbies.
1 parent 3ac2db1 commit d856bec

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

site/guidelines-authors.qmd

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ These templates provide a starting point for authors to format their contributio
6363

6464
### Setup a git repository {#sec-git}
6565

66+
::: {.callout-note title="Git and GitHub"}
67+
Git is a versioning tool and GitHub is an online platform owned by Microsoft which provides the service of hosting repositories with all the capabilities of versioning offered by Git.
68+
69+
Computo requires authors to submit their contribution as a GitHub repository. Hence, authors are expected to have basic knowledge of Git. We refer authors to the following online book which is particularly well written: <https://happygitwithr.com>.
70+
:::
71+
6672
Create a new GitHub repository by navigating to the [R](https://github.com/computorg/template-computo-R), [Python](https://github.com/computorg/template-computo-python), or [Julia](https://github.com/computorg/template-computo-julia) template repository and clicking the **"Use this template"** button at the top of the page, as shown in @fig-template.
6773

6874
![Screenshot of the R Computo template GitHub page.](/assets/img/computo-template-screenshot.png){#fig-template width="100%"}
@@ -71,7 +77,7 @@ Create a new GitHub repository by navigating to the [R](https://github.com/compu
7177
When you fork a GitHub repository – whether it is a classic repository or a template – GitHub will ask if you want to include all branches (there is a box labeled *Include all branches*). You only need to fork the main branch, so you do not need to check that box.
7278
:::
7379

74-
::: {.callout-caution title="Public repository"}
80+
::: {.callout-caution title="Public/private repository"}
7581
The paper will be automatically published online using GitHub pages. This is possible only with public repositories (which is the default behavior when you initialize your repository from this template). It is fine to keep your repository private during the writing phase. However, we ask you to set it public at the submission stage; so that the paper can be rendered and published online for the reviewers.
7682
:::
7783

0 commit comments

Comments
 (0)