Merge branch 'main' into patch-6

.github/dependabot.yml

@@ -0,0 +1,7 @@
+---
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of the package manifests
+    schedule:
+      interval: "daily" # Check for updates daily

.github/labeler.yml

@@ -1,5 +1,18 @@
 ---
 documentation:
-  - "**/*.md"
-  - "README.md"
-  - "docs/**"
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - '**/*.md'
+
+root:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - '*'
+
+github-actions:
+  - any:
+      - changed-files:
+          - any-glob-to-any-file:
+              - .github/**/*

.github/linters/.markdown-lint.yaml

@@ -3,3 +3,12 @@
 
 # line-length - Line length
 MD013: false
+
+# MD033/no-inline-html
+MD033: false
+
+# MD041/first-line-heading/first-line-h1
+MD041: false
+
+# MD051/link-fragments
+MD051: false

.github/workflows/labeler.yml

@@ -1,17 +1,19 @@
 ---
-name: "Pull Request Labeler"
+  name: "Pull Request Labeler"
 
-on:
-  pull_request:
-    types: [opened, synchronize]
+  on:
+    - pull_request_target
 
-jobs:
-  label:
-    runs-on: ubuntu-latest
+  jobs:
+    label:
+      runs-on: ubuntu-latest
+      permissions:
+        pull-requests: write  # Ensure write access for PRs
 
-    steps:
-      - name: Pull Request Labeler
-        uses: actions/labeler@v5
-        with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
-          configuration-path: ".github/labeler.yml"
+      steps:
+        - name: Pull Request Labeler
+          uses: actions/labeler@v5
+          with:
+            repo-token: "${{ secrets.GITHUB_TOKEN }}"
+            configuration-path: ".github/labeler.yml"
+            sync-labels: true

.github/workflows/pre-commit.yml

@@ -9,18 +9,18 @@
 
       steps:
         - name: Checkout code
-          uses: actions/checkout@v2
+          uses: actions/checkout@v4.2.2
 
         - name: Set up Python
-          uses: actions/setup-python@v2
+          uses: actions/setup-python@v5.3.0
           with:
             python-version: '3.13'  # Specify your Python version
 
         - name: Set Python Version Hash
-          run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+          run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"
 
         - name: Cache pre-commit
-          uses: actions/cache@v3
+          uses: actions/cache@v4
           with:
             path: ~/.cache/pre-commit
             key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}

.pre-commit-config.yaml

@@ -44,10 +44,26 @@ repos:
       - id: codespell
         args: ["--ignore-words", ".github/linters/codespell.txt"]
 
-  # Add ls-lint
   - repo: https://github.com/lojjic/pre-commit-ls-lint
     rev: v1.0.0
     hooks:
       - id: ls-lint
         name: Lint filenames and directories
-        description: An extremely fast file and directory name linter
+        description: An extremely fast file and directory name linter
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.21.2
+    hooks:
+      - id: gitleaks
+
+  - repo: https://github.com/shssoichiro/oxipng
+    rev: v9.1.2
+    hooks:
+      - id: oxipng
+        args: ["-o", "4", "--strip", "safe", "--alpha"]
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.3
+    hooks:
+      - id: actionlint
+

CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing Guide ✨
+
+Welcome to **Awesome Social Chess**! We appreciate your interest in contributing. All contributions are welcome! 💖
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Creating an Issue](#creating-an-issue)
+- [How to Contribute](#how-to-contribute)
+- [Community Support](#community-support)
+
+---
+
+## Getting Started
+
+Before you begin:
+
+- **Familiarize Yourself**: Take a moment to read through the existing [issues](https://github.com/brisbanesocialchess/awesome-social-chess/issues) and [pull requests](https://github.com/brisbanesocialchess/awesome-social-chess/pulls) to understand current discussions.
+
+## Creating an Issue
+
+If you encounter a bug or have a feature request, please create an issue:
+
+1. **Search Existing Issues**: Check if the issue already exists to avoid duplicates.
+2. **Open a New Issue**:
+   - Use a descriptive title.
+   - Clearly describe the problem or feature request.
+   - Provide steps to reproduce the issue, if applicable.
+   - Include screenshots or code snippets, if helpful.
+
+## How to Contribute
+
+We welcome contributions in the form of bug fixes, new features, documentation improvements, and more.
+
+### 1. Fork the Repository 🔗
+
+Click the **"Fork"** button at the top right corner of the repository page to create a copy of the repository on your GitHub account.
+
+### 2. Clone Your Fork 📥
+
+Clone the forked repository to your local machine:
+
+   ```bash
+   git clone https://github.com/your-username/social-chess.git
+   ```
+
+### 3. 🌿 Create a Branch
+
+  ```bash
+  cd awesome-social-chess
+  git checkout -b add-new-feature
+  ```
+
+### 4. ✏️ Make Changes - Make necessary improvements, such as fixing bugs, enhancing documentation, or adding new features
+
+### 5. 📝 Commit Changes
+
+Use descriptive commit messages that clearly state the purpose of your changes.
+
+  ```bash
+  git add .
+  git commit -m "Add feature: description of feature"
+  ```
+
+### 6. ⬆️ Push Changes
+
+  ```bash
+  git push origin add-new-feature
+  ```
+
+### 7. 🔄 Create a Pull Request
+
+- Go to your forked repository on GitHub.
+- Click **"Compare & pull request"**.
+- Add a title and description (e.g., "Fixes #38").
+- Click **"Create pull request"**.
+
+## Community Support
+
+If you need help or have questions:
+
+- Join Discussions: Participate in discussions.
+- Contact Maintainers: Reach out to project maintainers if needed.

README.md

@@ -1,25 +1,36 @@
-# Awesome Social Chess
+<div align="center">
 
-## Table of Contents
+  <img src="./assets/social-chess-logo.png" alt="Awesome Social Chess Logo" width="150" style="display:block; margin:auto; border-radius:8px;">
 
-- [Books](#books)
-- [Calendars](#calendars)
-- [Cards](#cards)
+# 🎉 Awesome Social Chess 🎉
 
-## Books
+</div>
 
-- **101 Questions On How To Play Chess** - Fred Wilson - Dover Game And Puzzle Activity Books
-- **Bobby Fischer Teaches Chess** - Bobby Fischer, Stuart Margulies, Donn Mosenfelder - Basic Systems Inc, Bantam Books
-- **Learn Chess: A Gold-medal Winner Explains How to Play and Win at Chess** - John Nunn - Gambit Publications Ltd
-- **Learn Chess From The Greats** - Peter J. Tamburro, Jr. - Dover Publications
-- **My System** - Winning Chess Strategies - Aron Nimzowitsch - SnowBall Publishing
-- **The Usborne Complete Book of Chess** - Elizabeth Dalby - Usborne Publishing Ltd
+## 📚 Table of Contents
 
-## Calendars
+- [📖 Books](#books)
+- [📅 Calendars](#calendars)
+- [🃏 Cards](#cards)
 
-- American Chess Magazine Chess 2024 - A Year of Chess Puzzles
+## 📖 Books
 
-## Cards
+| Title                                                               | Author(s)                                 | Publisher                         |
+|---------------------------------------------------------------------|-------------------------------------------|-----------------------------------|
+| **101 Questions On How To Play Chess**                              | Fred Wilson                               | Dover Game And Puzzle Activity Books |
+| **Bobby Fischer Teaches Chess**                                     | Bobby Fischer, Stuart Margulies, Donn Mosenfelder | Basic Systems Inc, Bantam Books |
+| **Chess Openings For Dummies**                                      | James Eade                                | For Dummies                       |
+| **Learn Chess: A Gold-medal Winner Explains How to Play and Win at Chess** | John Nunn                                 | Gambit Publications Ltd           |
+| **Learn Chess From The Greats**                                     | Peter J. Tamburro, Jr.                    | Dover Publications                |
+| **My System: Winning Chess Strategies**                             | Aron Nimzowitsch                          | SnowBall Publishing               |
+| **The Usborne Complete Book of Chess**                              | Elizabeth Dalby                           | Usborne Publishing Ltd            |
 
-- Chess Endgame Cards general - Benoni 1: Standard size playing cards
-- The Chess Deck - 50 Cards For Mastering The Basics - Levy Rozman AKA GOTHAMCHESS: Large deck of cards
+## 📅 Calendars
+
+- **American Chess Magazine Chess 2024** - A Year of Chess Puzzles
+
+## 🃏 Cards
+
+| Title                                                               | Description                               |
+|---------------------------------------------------------------------|-------------------------------------------|
+| **Chess Endgame Cards General: Benoni 1**                           | Standard size playing cards               |
+| **The Chess Deck**                                                  | 50 Cards For Mastering The Basics - Levy Rozman AKA GOTHAMCHESS: Large deck of cards |