Skip to content

Commit

Permalink
Merge pull request #5 from lnnrtwttkhn/codespell
Browse files Browse the repository at this point in the history
add codespell to prevent typos: config, workflow and some fixed typos
  • Loading branch information
HeidiSeibold authored Oct 24, 2023
2 parents 16ed1a2 + 60e1bbd commit 92ed30a
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 5 deletions.
4 changes: 4 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[codespell]
skip = .git,renv.lock,renv,impressum.qmd
#
# ignore-words-list =
22 changes: 22 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
- name: Codespell
uses: codespell-project/actions-codespell@v2
2 changes: 1 addition & 1 deletion 1-3-fair.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The FAIR principles are at the core of many current initiatives in research and
![FAIR prinicples](images/fair.jpg){fig-alt="F=findable, A=accessible, I=interoperable, R=reusable"}
:::

This chapter is based on ressources from the University of Mannheim, that I
This chapter is based on resources from the University of Mannheim, that I
recommend to check out: [https://github.com/UB-Mannheim/FAIR-Data-Week](https://github.com/UB-Mannheim/FAIR-Data-Week).
In the following I will use these and my own experience to give you a bit of a
guidance on how to get started.
Expand Down
2 changes: 1 addition & 1 deletion 1-4-team-work.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ they discuss 8 steps, that work well for a broad range of research teams:
7. Identify Failed Approaches, and Stop Them
8. Have Documentation (e.g. a wiki) and Dissemination Plans for Your Project (e.g. publication on Zenodo)

Note that there are two important parts fo thriving teams:
Note that there are two important parts for thriving teams:

- Documents (wiki, checklist, ...)
- Roles of people (research software engineer, welcome team, ...)
Expand Down
2 changes: 1 addition & 1 deletion 3-4-automate.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ gets updated if needed.

### Further reading
We just showed a very simple example in this chapter. `Make` can become much more
complex and versatile. Check out the following ressources if you'd like to dive
complex and versatile. Check out the following resources if you'd like to dive
deeper:

- [Make](https://the-turing-way.netlify.app/reproducible-research/make.html), The Turing Way
Expand Down
4 changes: 2 additions & 2 deletions 4-3-fair-revisited.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Software is both usable (can be executed) and reusable (can be understood, modif

### Reproducbile research practices support FAIRness

In the following we want ot look at the practices we learned about and discuss,
In the following we want to look at the practices we learned about and discuss,
if the help us with FAIRness.

#### Project organization
Expand Down Expand Up @@ -79,5 +79,5 @@ If you have a clear license and publish your work...

The cool thing about this course is, that you learned about reproducible research, but on the side you also learned how to make your work FAIR and maybe even open.

In the points above, we probaly even missed a few more that could be added. Any other points that come to your mind?
In the points above, we probably even missed a few more that could be added. Any other points that come to your mind?

0 comments on commit 92ed30a

Please sign in to comment.