Initial stab

.all-contributorsrc

@@ -1,7 +1,5 @@
 {
-  "files": [
-    "README.md"
-  ],
+  "files": ["README.md"],
   "imageSize": 100,
   "commit": false,
   "contributorsPerLine": 7,
@@ -18,28 +16,29 @@
       "name": "Maruan",
       "avatar_url": "https://avatars.githubusercontent.com/u/2126561?v=4",
       "profile": "http://maruan.alshedivat.com",
-      "contributions": [
-        "design",
-        "code"
-      ]
+      "contributions": ["design", "code"]
     },
     {
       "login": "rohandebsarkar",
       "name": "Rohan Deb Sarkar",
       "avatar_url": "https://avatars.githubusercontent.com/u/50144004?v=4",
       "profile": "http://rohandebsarkar.github.io",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "pourmand1376",
       "name": "Amir Pourmand",
       "avatar_url": "https://avatars.githubusercontent.com/u/32064808?v=4",
       "profile": "https://amirpourmand.ir",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
+    },
+    {
+      "login": "george-gca",
+      "name": "George",
+      "avatar_url": "https://avatars.githubusercontent.com/u/31376482?v=4",
+      "profile": "https://george-gca.github.io/",
+      "contributions": ["code"]
     }
-  ]
+  ],
+  "commitConvention": "angular"
 }

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
+{
+  "name": "Jekyll",
+  "image": "mcr.microsoft.com/devcontainers/jekyll",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
+      "packages": "build-essential,imagemagick,inotify-tools,jupyter-nbconvert,procps,ruby-full,zlib1g-dev"
+    },
+    "ghcr.io/devcontainers-contrib/features/prettier:1": {}
+  },
+
+  // Optionally: run jekyll serve automatically on container entering using the Docker entrypoint
+  "postAttachCommand": "./bin/entry_point.sh",
+
+  "customizations": {
+    "vscode": {
+      "extensions": ["esbenp.prettier-vscode", "sissel.shopify-liquid", "yzhang.markdown-all-in-one"],
+      "settings": {
+        // use prettier code formatter as default formatter
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "prettier.configPath": ".prettierrc",
+        "editor.formatOnSave": true
+      }
+    }
+  },
+
+  "remoteUser": "vscode"
+}

.dockerignore

@@ -0,0 +1,3 @@
+_site/
+.git/
+assets/

.git-blame-ignore-revs

@@ -0,0 +1,24 @@
+# Template taken from https://github.com/v8/v8/blob/master/.git-blame-ignore-revs.
+#
+# This file contains a list of git hashes of revisions to be ignored by git blame. These
+# revisions are considered "unimportant" in that they are unlikely to be what you are
+# interested in when blaming. Most of these will probably be commits related to linting
+# and code formatting.
+#
+# Instructions:
+# - Only large (generally automated) reformatting or renaming CLs should be
+#   added to this list. Do not put things here just because you feel they are
+#   trivial or unimportant. If in doubt, do not put it on this list.
+# - Precede each revision with a comment containing the PR title and number.
+#   For bulk work over many commits, place all commits in a block with a single
+#   comment at the top describing the work done in those commits.
+# - Only put full 40-character hashes on this list (not short hashes or any
+#   other revision reference).
+# - Append to the bottom of the file (revisions should be in chronological order
+#   from oldest to newest).
+# - Because you must use a hash, you need to append to this list in a follow-up
+#   PR to the actual reformatting PR that you are trying to ignore.
+
+# Format all the code using prettier.io. (#2048, #2062)
+beb6f27d596e753014cb9bff1939e5f78d66431c
+2d34024961c3a3d27d6fd18ce06a551657983234

.github/ISSUE_TEMPLATE/1_bug_report.yml

@@ -0,0 +1,102 @@
+name: 🐛 Report a bug
+description: Any errors.
+labels: ["needs triage", "bug"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Before you go any further. Is this really a **🐛 bug**?
+
+        If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
+        [frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
+        [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
+        or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
+
+  - type: checkboxes
+    id: requirements
+    attributes:
+      label: Have you checked that your issue isn't already filed?
+      description: >
+        Please check if somebody else has already filed the same issue.
+        If you find a similar issue, please add a 👍 reaction or comment on the original post.
+      options:
+        - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
+          required: true
+        - label: Yes, I have checked that this issue isn't already filed.
+          required: true
+
+  - type: input
+    attributes:
+      label: Bug description
+      description: A description of the 🐛 bug.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How to reproduce the bug
+      description: Provide steps to reproduce the 🐛 bug.
+      placeholder: |
+        Include steps to reproduce, the expected behaviour, and the actual behaviour.
+
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Error messages and logs
+      description: >
+        Provide any error messages and/or logs
+      placeholder: "Copy the complete error messages and logs"
+      value: |
+        ```
+        The error message you got, with the full traceback if available. Please paste it between these triple backticks.
+        ```
+    validations:
+      required: false
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: What operating system are you using?
+      description: select all OSs where you have experienced this issue
+      multiple: true
+      options:
+        - Linux
+        - Mac
+        - Windows
+        - Not applicable (e.g. you're using GitHub Pages or other hosting)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Where are you seeing the problem on?
+      description: select all environments where you have experienced this issue
+      multiple: true
+      options:
+        - "Running locally with Docker (docker compose)"
+        - "Running locally with Docker (devcontainer)"
+        - "Running locally without Docker"
+        - "Deployed site"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: More info
+      description: Add any other info about the issue here.
+      placeholder: |
+        Add any other context about the problem here, such as versions of the libraries if running without docker, screenshots, links to the deployed site, etc.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: "**Happy coding!**"

.github/ISSUE_TEMPLATE/2_feature_request.yml

@@ -0,0 +1,56 @@
+name: 🚀 Feature request
+description: Propose a feature for this project
+labels: ["needs triage", "enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Before you go any further, are you sure that this feature is not already implemented?
+
+        If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
+        [frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
+        [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
+        or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
+
+  - type: checkboxes
+    id: requirements
+    attributes:
+      label: Have you checked that your feature request isn't already filed?
+      description: >
+        Please check if somebody else has already filed the same 🚀 feature request.
+        If you find a similar feature request, please add a 👍 reaction or comment on the original post.
+      options:
+        - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
+          required: true
+        - label: Yes, I have checked that this feature request isn't already filed.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description & Motivation
+      description: A clear and concise description of the 🚀 feature proposal
+      placeholder: |
+        Please outline the motivation for the proposal.
+        Is your feature request related to a problem? e.g., I'm always frustrated when [...].
+        If this is related to another GitHub issue, please link it here
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered, if any.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Ask a Question
+    url: https://github.com/alshedivat/al-folio/discussions/categories/q-a
+    about: Ask and answer al-folio related questions.
+  - name: 📖 Read the documentation
+    url: https://github.com/alshedivat/al-folio/blob/main/README.md
+    about: Please consult the documentation before opening any issues!

.github/release.yml

@@ -0,0 +1,14 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    - title: new features 🚀
+      labels:
+        - enhancement
+    - title: bug fixes and improvements ✨
+      labels:
+        - bug-fix
+    - title: other changes 🛠️
+      labels:
+        - "*"