Skip to content

Commit

Permalink
Merge branch 'main' into patch-6
Browse files Browse the repository at this point in the history
  • Loading branch information
jbampton authored Dec 24, 2024
2 parents 1929248 + b1832b9 commit 2cbd680
Show file tree
Hide file tree
Showing 14 changed files with 171 additions and 79 deletions.
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/" # Location of the package manifests
- package-ecosystem: 'github-actions'
directory: '/' # Location of the package manifests
schedule:
interval: "daily" # Check for updates daily
interval: 'daily' # Check for updates daily
33 changes: 18 additions & 15 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
---
name: "Pull Request Labeler"
name: 'Pull Request Labeler'

on:
- pull_request_target
on:
- pull_request_target

jobs:
label:
runs-on: ubuntu-latest
permissions:
pull-requests: write # Ensure write access for PRs
permissions:
contents: read

steps:
- name: Pull Request Labeler
uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
configuration-path: ".github/labeler.yml"
sync-labels: true
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'
sync-labels: true
35 changes: 35 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Lint

on: # yamllint disable-line rule:truthy
push: null
pull_request: null

permissions:
contents: read

jobs:
build:
name: Lint
runs-on: ubuntu-latest

permissions:
contents: read
packages: read
# To report GitHub Actions status checks
statuses: write

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
fetch-depth: 0

- name: Super-linter
uses: super-linter/[email protected] # x-release-please-version
env:
# To report GitHub Actions status checks
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MARKDOWN_CONFIG_FILE: .markdown-lint.yaml
53 changes: 28 additions & 25 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
---
name: Pre-commit
name: Pre-commit

on: [push, pull_request]
on: [push, pull_request]

jobs:
pre-commit:
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout code
uses: actions/[email protected]
jobs:
pre-commit:
runs-on: ubuntu-latest

- name: Set up Python
uses: actions/[email protected]
with:
python-version: '3.13' # Specify your Python version
steps:
- name: Checkout code
uses: actions/[email protected]

- name: Set Python Version Hash
run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"
- name: Set up Python
uses: actions/[email protected]
with:
python-version: '3.13' # Specify your Python version

- name: Cache pre-commit
uses: actions/cache@v4
with:
path: ~/.cache/pre-commit
key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
- name: Set Python Version Hash
run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> "$GITHUB_ENV"

- name: Install pre-commit
run: |
python -m pip install --upgrade pip
pip install pre-commit
- name: Cache pre-commit
uses: actions/cache@v4
with:
path: ~/.cache/pre-commit
key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}

- name: Run pre-commit
run: pre-commit run --all-files
- name: Install pre-commit
run: |
python -m pip install --upgrade pip
pip install pre-commit
- name: Run pre-commit
run: pre-commit run --all-files
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,5 @@ Thumbs.db
*.swp
*.swo
*.pid

.venv/
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ repos:
- id: yamllint
name: run yamllint
description: Lint YAML files
args: ["-c", ".github/linters/.yamllint.yaml"]
args: ['-c', '.github/linters/.yamllint.yaml']
files: \.ya?ml$

- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
args: ["--ignore-words", ".github/linters/codespell.txt"]
args: ['--ignore-words', '.github/linters/codespell.txt']

- repo: https://github.com/lojjic/pre-commit-ls-lint
rev: v1.0.0
Expand All @@ -60,7 +60,7 @@ repos:
rev: v9.1.2
hooks:
- id: oxipng
args: ["-o", "4", "--strip", "safe", "--alpha"]
args: ['-o', '4', '--strip', 'safe', '--alpha']

- repo: https://github.com/rhysd/actionlint
rev: v1.7.3
Expand Down
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"singleQuote": true
}
30 changes: 15 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you encounter a bug or have a feature request, please create an issue:

## How to Contribute

We welcome contributions in the form of bug fixes, new features, documentation improvements, and more.
We welcome contributions in the form of bugfixes, new features, documentation improvements, and more.

### 1. Fork the Repository 🔗

Expand All @@ -40,33 +40,33 @@ Click the **"Fork"** button at the top right corner of the repository page to cr

Clone the forked repository to your local machine:

```bash
git clone https://github.com/your-username/social-chess.git
```
```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
```
```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"
```
```bash
git add .
git commit -m "Add feature: description of feature"
```

### 6. ⬆️ Push Changes

```bash
git push origin add-new-feature
```
```bash
git push origin add-new-feature
```

### 7. 🔄 Create a Pull Request

Expand Down
15 changes: 15 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.PHONY: check
check: checkinstall
pre-commit run --all-files

.PHONY: checkinstall
checkinstall:
pre-commit install

.PHONY: checkupdate
checkupdate: checkinstall
pre-commit autoupdate

.PHONY: install
install:
pip install -r requirements.txt
62 changes: 44 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
<div align="center">

<img src="./assets/social-chess-logo.png" alt="Awesome Social Chess Logo" width="150" style="display:block; margin:auto; border-radius:8px;">

# 🎉 Awesome Social Chess 🎉

<img src="assets/social-chess-logo.png" alt="Awesome Social Chess Logo" width="150" style="display:block; margin:auto; border-radius:8px;">
<h1>🎉 Awesome Social Chess 🎉</h1>
<p>
<a href="https://github.com/sindresorhus/awesome"><img alt="Awesome" src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" title="Awesome"></a>
</p>
<p>
<a href="https://github.com/rhysd/actionlint"><img alt="actionlint" src="https://img.shields.io/badge/actionlint-enabled-brightgreen"></a>
<a href="https://github.com/codespell-project"><img alt="codespell" src="https://img.shields.io/badge/codespell-enabled-brightgreen"></a>
<a href="https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners"><img alt="CODEOWNERS" src="https://img.shields.io/badge/CODEOWNERS-enabled-brightgreen"></a>
<a href="https://github.com/dependabot"><img alt="Dependabot" src="https://img.shields.io/badge/Dependabot-enabled-brightgreen"></a>
<a href="https://github.com/editorconfig"><img alt="EditorConfig" src="https://img.shields.io/badge/EditorConfig-enabled-brightgreen"></a>
<a href="https://pages.github.com/"><img alt="GitHub Pages" src="https://img.shields.io/badge/GitHub_Pages-enabled-brightgreen"></a>
<a href="https://github.com/gitleaks/gitleaks"><img alt="Gitleaks" src="https://img.shields.io/badge/gitleaks-enabled-brightgreen"></a>
<a href="https://github.com/jekyll"><img alt="Jekyll" src="https://img.shields.io/badge/Jekyll-enabled-brightgreen"></a>
<a href="https://www.gnu.org/software/make/"><img alt="Makefile" src="https://img.shields.io/badge/Makefile-enabled-brightgreen"></a>
<a href="https://github.com/DavidAnson/markdownlint"><img alt="markdownlint" src="https://img.shields.io/badge/markdownlint-enabled-brightgreen"></a>
<a href="https://github.com/shssoichiro/oxipng"><img alt="oxipng" src="https://img.shields.io/badge/oxipng-enabled-brightgreen"></a>
<a href="https://github.com/pre-commit"><img alt="pre-commit" src="https://img.shields.io/badge/pre--commit-enabled-brightgreen"></a>
<a href="https://github.com/actions/labeler"><img alt="Pull Request Labeler" src="https://img.shields.io/badge/Pull_Request_Labeler-enabled-brightgreen"></a>
<a href="https://pip.pypa.io/en/stable/reference/requirements-file-format/"><img alt="requirements.txt" src="https://img.shields.io/badge/requirements.txt-enabled-brightgreen"></a>
<a href="https://github.com/adrienverge/yamllint"><img alt="yamllint" src="https://img.shields.io/badge/yamllint-enabled-brightgreen"></a>
</p>
</div>

## 📚 Table of Contents
Expand All @@ -14,23 +31,32 @@

## 📖 Books

| 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 |
| 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 for Kids: How to Play and Win** | Richard James | Robinson; 2nd edition (2015) |
| **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 |
| **Learn To Play Chess Like A Boss** | Patrick Wolff | Penguin Random House Dorling Kindersley |
| **MY 60 Memorable Games: Chess Tactics, Chess Strategies** | Bobby Fischer | Batsford GB |
| **My System: Winning Chess Strategies** | Aron Nimzowitsch | SnowBall Publishing |
| **The Caro-Kann The Easy Way** | Thomas Engqvist | Batsford Chess |
| **The Life and Games of Mikhail Tal** | Everyman Chess Classic | Everyman Chess |
| **The Usborne Complete Book of Chess** | Elizabeth Dalby | Usborne Publishing Ltd |

## 📅 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 |
| 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 |

## Sponsor Our Developers 🪙 💵 💰 💳 🏧

[![John Bampton](assets/sponsor-jbampton.png)](https://github.com/sponsors/jbampton)
4 changes: 4 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
remote_theme: pages-themes/[email protected]
plugins:
- jekyll-remote-theme
Binary file modified assets/social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/sponsor-jbampton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pre-commit

0 comments on commit 2cbd680

Please sign in to comment.