fix: Fix broken links in readme file (#6)

Author: thedaviddias

.github/workflows/development.yml

@@ -32,6 +32,9 @@ jobs:
       - name: 🧹 Run lint
         run: yarn lint
 
+      - name: 🔗 Run check links
+        run: yarn run check-links
+
       - name: 🐛 Run tests
         run: yarn test:coverage
 

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+Thanks for being willing to contribute!
+
+**Working on your first Pull Request?** You can learn how from this _free_
+series [How to Contribute to an Open Source Project on GitHub][egghead]
+
+## Project setup
+
+1.  Fork and clone the repo
+2.  Run `yarn install` to install dependencies
+3.  Create a branch for your PR with `git checkout -b pr/your-branch-name`
+
+> Tip: Keep your `main` branch pointing at the original repository and make pull
+> requests from branches on your fork. To do this, run:
+>
+> ```
+> git remote add upstream https://github.com/thedaviddias/gatsby-source-notion-article.git
+> git fetch upstream
+> git branch --set-upstream-to=upstream/main main
+> ```
+>
+> This will add the original repository as a "remote" called "upstream," Then
+> fetch the git information from that remote, then set your local `main` branch
+> to use the upstream main branch whenever you run `git pull`. Then you can make
+> all of your pull request branches based on this `main` branch. Whenever you
+> want to update your version of `main`, do a regular `git pull`.
+
+## Committing and Pushing changes
+
+Please make sure to run the tests before you commit your changes. You can run
+`yarn run test` to run Jest or `yarn run test:watch` on watch mode. Make
+sure to include those changes (if they exist) in your commit.
+
+## Help needed
+
+Please checkout the [the open issues][issues]
+
+Also, please watch the repo and respond to questions/bug reports/feature
+requests! Thanks!
+
+[egghead]: https://app.egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
+[all-contributors]: https://github.com/all-contributors/all-contributors
+[issues]: https://github.com/thedaviddias/gatsby-source-notion-article/issues

CONTRIBUTION.md

@@ -17,9 +17,10 @@
   "author": "David Dias <hello@thedaviddias.dev>",
   "scripts": {
     "build": "babel src --out-dir dist/ --ignore \"src/__tests__\" --ignore \"src/mockData\" --extensions \".ts\"",
+    "check-links": "git ls-files | grep md$ | xargs -n 1 markdown-link-check",
     "lint": "eslint --fix --ext .ts,.js --max-warnings 0",
     "prepare": "cross-env NODE_ENV=production npm run build && npm run typegen",
-    "test": "jest",
+    "test": "jest ./src",
     "test:coverage": "npm test -- --coverage --watchAll=false ./src",
     "test:watch": "jest --watchAll ./src",
     "typecheck": "tsc",
@@ -55,6 +56,7 @@
     "jest": "26.6.3",
     "jest-cli": "26.6.3",
     "json-stringify-safe": "5.0.1",
+    "markdown-link-check": "3.8.7",
     "nock": "13.0.11",
     "prettier": "2.3.0",
     "semantic-release": "17.4.3",