Big update!

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# Support 'GitHub Sponsors' funding.
+github: dwmkerr

.github/contributing.md

@@ -1,5 +1,17 @@
 # Contributing Guidelines
 
+<!-- vim-markdown-toc GFM -->
+
+* [Goal of the Project](#goal-of-the-project)
+* [Example Law: The Law of Leaky Abstractions](#example-law-the-law-of-leaky-abstractions)
+* [Localisation](#localisation)
+* [How do I know if a law is relevant?](#how-do-i-know-if-a-law-is-relevant)
+* [How do I know if a law is 'well known' enough?](#how-do-i-know-if-a-law-is-well-known-enough)
+
+<!-- vim-markdown-toc -->
+
+## Goal of the Project
+
 The goal of this project is to have a set of _concise_ definitions to laws, principles, methodologies and patterns which hackers will find useful. They should be:
 
 1. Short - one or two paragraphs.
@@ -17,12 +29,13 @@ Some other tips:
 - Be careful not to copy-and-paste content (unless it is explicitly quoted), as it might violate copyright.
 - Include hyperlinks to referenced material.
 - Do not advocate for the law, or aim to be opinionated on the correctness or incorrectness of the law, as this repository is simply the descriptions and links.
+- Avoid 'you' when writing. For example, prefer "This law suggests refactoring should be avoided when..." rather than "you should avoid refactoring when...". This keeps the style slightly more formal and avoids seeming like advocation of a law.
 
 An example law is shown below, which covers most of the key points:
 
 ---
 
-### The Law of Leaky Abstractions
+## Example Law: The Law of Leaky Abstractions
 
 [The Law of Leaky Abstractions on Joel on Software](https://www.joelonsoftware.com/2002/11/11/the-law-of-leaky-abstractions/)
 
@@ -45,3 +58,19 @@ See also:
 Real-world examples:
 
 - [Photoshop Slow Startup](https://forums.adobe.com/thread/376152) - an issue I encountered in the past. Photoshop would be slow to startup, sometimes taking minutes. It seems the issue was that on startup it reads some information about the current default printer. However, if that printer is actually a network printer, this could take an extremely long time. The _abstraction_ of a network printer being presented to the system similar to a local printer caused an issue for users in poor connectivity situations.
+
+## Localisation
+
+We are currently using [GitLocalize](https://gitlocalize.com) to handle translations. This provides features to make it easier for people to manage translations as changes come in:
+
+![GitLocalize Screenshot](../images/gitlocalize.png)
+
+This is still work in progress - if you would like to be a maintainer for a language just open an issue to get in touch!
+
+## How do I know if a law is relevant?
+
+In general, it should be reasonably applicable to the world of computer sciences, IT or coding in general.
+
+## How do I know if a law is 'well known' enough?
+
+A good test is 'If I search for it on Google, will I find it in the first few results?'.

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 
 Please double check the items below!
 
-- [ ] I have read the [Contributor Guidelines](./.github/contributing.md).
+- [ ] I have read the [Contributor Guidelines](https://github.com/dwmkerr/hacker-laws/blob/master/.github/contributing.md).
 - [ ] I have not directly copied text from another location (unless explicitly indicated as a quote) or violated copyright.
 - [ ] I have linked to the original Law.
 - [ ] I have quote the law (if possible) and the author's name (if possible).

.github/workflows/build-on-pull-request.yaml

@@ -0,0 +1,43 @@
+# This pipeline builds the PDF ebook on any pull request to master.
+name: "Build PDF"
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  prepare-pdf:
+    # Focal Fossa. Please don't use 'latest' tags, it's an anti-pattern.
+    runs-on: ubuntu-20.04
+    steps:
+      # Checkout the code.
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # Set a descriptive version. For PRs it'll be the short sha.
+      - name: Set Version
+        id: set_version
+        run: echo ::set-output name=VERSION::$(git rev-parse --short HEAD)
+
+      # Prepare the content files.
+      - name: Prepare Content
+        run: ./scripts/prepare-markdown-for-ebook.sh ${{ steps.set_version.outputs.VERSION }}
+
+      # Create a PDF from the prepared markdown.
+      - name: Prepare PDF
+        uses: docker://pandoc/latex:2.9
+        with:
+          args: "-V toc-title:\"Table Of Contents\" --toc --pdf-engine=pdflatex --standalone --output hacker-laws.pdf hacker-laws.md"
+
+      # Publish the PDF and intermediate markdown as an artifact.
+      - name: Publish PDF Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: hacker-laws.pdf
+          path: hacker-laws.pdf
+
+      - name: Publish Intermiediate Markdown Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: hacker-laws.md
+          path: hacker-laws.md

.github/workflows/release-on-tag.yaml

@@ -0,0 +1,69 @@
+# This pipeline builds the PDF ebook on any tag starting with 'v'.
+name: "Create Release"
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  prepare-pdf:
+    # Focal Fossa. Please don't use 'latest' tags, it's an anti-pattern.
+    runs-on: ubuntu-20.04
+    steps:
+      # Checkout the code.
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # Set a descriptive version. For PRs it'll be the short sha.
+      - name: Set Version
+        id: set_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+
+      # Prepare the content files.
+      - name: Prepare Content
+        run: ./scripts/prepare-markdown-for-ebook.sh ${{ steps.set_version.outputs.VERSION }}
+
+      # Create a PDF from the prepared markdown.
+      - name: Prepare PDF
+        uses: docker://pandoc/latex:2.9
+        with:
+          args: "-V toc-title:\"Table Of Contents\" --toc --pdf-engine=pdflatex --standalone --output hacker-laws.pdf hacker-laws.md"
+
+      # Publish the PDF artifact.
+      - name: Publish PDF Artifacts
+        uses: actions/upload-artifact@master
+        with:
+          name: hacker-laws.pdf
+          path: hacker-laws.pdf
+
+  release:
+    needs: prepare-pdf
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: hacker-laws.pdf
+
+      - name: Create Release
+        id: create-release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Hacker Laws E-Book
+          draft: false
+          prerelease: false
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create-release.outputs.upload_url }}
+          asset_path: ./hacker-laws.pdf
+          asset_name: hacker-laws.pdf
+          asset_content_type: application/pdf