Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
fkohrt committed Sep 8, 2024
1 parent b0a8339 commit 2b0eb43
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion choose_license.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Two other notable definitions include the _Open Definition_ [@OKFN2016], which w

### Existing License?

First, if you adapt (i.e., modify, build on) a work by others you need to determine if it is provided to you under a free/open license.[You can determine whether a license is free/open by searching for its name in the [SPDX License List](https://spdx.org/licenses/) and looking for at least one `Y` in the two columns _FSF Free/Libre?_ and _OSI Approved?_]{.aside} If yes, we we recommend you to make your contribution available under the same license.^[Copyleft licenses even require you to choose the same or a compatible license.] For example, if you adapt code published in another paper, choose the same license for your modifications. The same applies if there are strong community norms to use a particular free/open license.^[Of course, this is only a heuristic and there might be good reasons to deviate from community norms.] Importantly, as discussed before, you are generally not allowed to adapt a work _not_ published under a free/open license.
First, if you adapt (i.e., modify, build on) a work by others you need to determine if it is provided to you under a free/open license.[You can determine whether a license is free/open by searching for its name in the [SPDX License List](https://spdx.org/licenses/) and looking for at least one `Y` in the two columns _FSF Free/Libre?_ and _OSI Approved?_]{.aside} If yes, we recommend you to make your contribution available under the same license.^[Copyleft licenses even require you to choose the same or a compatible license.] For example, if you adapt code published in another paper, choose the same license for your modifications. The same applies if there are strong community norms to use a particular free/open license.^[Of course, this is only a heuristic and there might be good reasons to deviate from community norms.] Importantly, as discussed before, you are generally not allowed to adapt a work _not_ published under a free/open license.

### Work Type?

Expand Down
6 changes: 3 additions & 3 deletions make_readme.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ engine: knitr

## Creating a README

Once you have prepared your project and settled on a license, it is time to add a final touch. Imagine you are coming back to your project in five years, having forgotten most of the details of what you did exactly. What would be useful to know in order to quickly understand what is going on in the project? This is what needs to be described in the README. While you could just start writing along, most READMEs have some sections in common which we describe below.
Once you have prepared your project and settled on a license, it is time to add a final touch. Imagine returning to your project in five years, having forgotten most of the details of what you did exactly. What would be useful to know in order to quickly understand what is going on in the project? This is what needs to be described in the README. While you could just start writing along, most READMEs have some sections in common which we describe below.

Name

Expand All @@ -22,7 +22,7 @@ Description

Visuals

: If there is anything you can show that demonstrates how the project can be used? Screenshots or other visuals can make the README more appealing.
: Is there anything you can show that demonstrates how the project can be used? Screenshots or other visuals can make the README more appealing.

Installation/Dependencies

Expand Down Expand Up @@ -100,7 +100,7 @@ Authors

Citation

: Is there a recommended way to cite this project? We recommend to increase citability by using the [CodeMeta generator](https://codemeta.github.io/codemeta-generator/) to create the file `codemeta.json`. Alternatively, one can also use the R package [`codemetar`](https://docs.ropensci.org/codemetar/) to create the file.
: Is there a recommended way to cite this project? We recommend to increase citability by using the [CodeMeta generator](https://codemeta.github.io/codemeta-generator/) to create a file called `codemeta.json`. Alternatively, one can also use the R package [`codemetar`](https://docs.ropensci.org/codemetar/) to create this file. Then, put it into the project folder.

License

Expand Down
4 changes: 2 additions & 2 deletions setup.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ And choose the project type _Quarto Project_.

Finally, enter the name of the directory where our report will be created in, for example `code-publishing-exercise`.

As we will use Git to track the version history of files, be sure to check _Create a git repository_. If you don't know what Git is, have a look at the tutorial "[Introduction to version Control with git and GitHub within RStudio](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/)".
As we will use Git to track the version history of files, be sure to check _Create a git repository_. If you don't know what Git is, have a look at the tutorial "[Introduction to version control with git and GitHub within RStudio](https://lmu-osc.github.io/Introduction-RStudio-Git-GitHub/)".

::: {.column-margin}
![renv: A dependency management toolkit for R](images/renv.svg){width=250px}
Expand Down Expand Up @@ -349,7 +349,7 @@ When you start a new session from the project root, the file is automatically re
query_api(..., api_key = Sys.getenv("MY_FIRST_KEY"))
```

Make sure that `.Renviron` is added to your `.gitignore` file in order to exclude it from the Git repository. If you already committed a file that you found contains credentials, you can follow @Chacon2024.
Make sure that `.Renviron` is added to your `.gitignore` file in order to exclude it from the Git repository. If you already committed a file that contains credentials, you can follow @Chacon2024.
:::

### Coding Best Practices
Expand Down

0 comments on commit 2b0eb43

Please sign in to comment.