Merge pull request #394 from NLeSC/376_version_control

add version control to Best Practices chapter

Author: egpbos

.github/workflows/link-checker-pr.yml

@@ -35,4 +35,4 @@ jobs:
       - name: Check all this file's additions for broken links
         run: |
           export base_sha=$(git rev-parse ${{ github.sha }}^)
-          git diff -U0 ${base_sha} ${{ github.event.pull_request.head.sha }} -- ${{ matrix.file }} | grep -v "+++" | grep "^+" | cut -c 2- | ./lychee -
+          git diff -U0 ${base_sha} ${{ github.event.pull_request.head.sha }} -- ${{ matrix.file }} | grep -v "+++" | grep "^+" | cut -c 2- | ./lychee --exclude nlesc.sharepoint.com -

.github/workflows/link-checker.yml

@@ -16,7 +16,7 @@ jobs:
         id: lychee
         with:
           # note: args has a long default value; when you override it, make sure you don't accidentally forget to include the default options you want! see https://github.com/lycheeverse/lychee-action/blob/master/action.yml
-          args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst' --accept '100..=103,200..=299, 429'
+          args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst' --accept '100..=103,200..=299, 429' --exclude nlesc.sharepoint.com
         env:
           # This token is included to avoid github.com requests to error out with status 429 (too many requests). It only works for GitHub requests (also other GitHub REST API calls), not for the rest of the web.
           GITHUB_TOKEN: ${{secrets.TOKEN_GITHUB}}

best_practices/overview.md

@@ -8,6 +8,14 @@ An easy way to make sure you did not forget anything important is to use a well
 Great examples can be found via [FAIR Software NL](https://fair-software.nl/recommendations/checklist).
 [The Turing Way](https://book.the-turing-way.org) has specific topical checklists at the end of each of their chapters.
 
+## Version control
+
+Use a version control tool like `git` to track changes in your codebase.
+This allows you to retrace your steps when debugging, keep your repository clean, easily collaborate with others asynchronously and more.
+More info: [The Turing Way chapter on Version Control](https://book.the-turing-way.org/reproducible-research/vcs), [RSQkit chapter on Version Control](http://everse.software/RSQKit/version_control).
+
+**@ NLeSC:** we always use version control and we preferably use GitHub as our online repository and collaboration platform (see the [Project Management Protocol on our intranet](https://nlesc.sharepoint.com/sites/home/SitePages/Project-procedures.aspx)).
+
 ## Know your tools
 
 In addition to the advice on the best practices above, knowing the