Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .claude/skills
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../.agents/skills
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_site/
.git/
assets/
24 changes: 24 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Force LF line endings, needed for Docker to work on Windows
*.sh text eol=lf
47 changes: 47 additions & 0 deletions .github/GIT_WORKFLOW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Git Workflow

This document outlines the conventions for using Git and writing commit messages in this project.

## Commit Message Format

All commit messages should follow this format:

```
<type>: <subject>
<body (optional)>
```

**Types:**

- `feat`: A new feature
- `fix`: A bug fix
- `docs`: Documentation only changes
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
- `config`: Changes to configuration files
- `chore`: Changes to the build process or auxiliary tools and libraries

**Examples:**

```
feat: Add dark mode toggle button to header
fix: Correct baseurl in project site configuration
docs: Update docs/INSTALL.md with Docker troubleshooting
style: Format all Liquid templates with Prettier
config: Enable blog section in _config.yml
chore: Update Jekyll dependencies with bundle update --all
```

## Staging Changes

**Always `git add` files explicitly.** Do not stage everything with `git add .` unless you are certain of what's being committed. Check `git status` first to review your changes.

## What NOT to Commit

**Always obey the project's [`.gitignore`](../.gitignore) file.** It prevents the accidental commit of:

- Build outputs (`_site/`, `.jekyll-cache/`)
- Dependencies (`node_modules/`, `vendor/`)
- OS-specific files (`.DS_store`)
- Editor temporary files (`.idea/`, `.swp`, `.swo`)
- Secrets and API keys (never commit credentials)
102 changes: 102 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -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/docs/README.md),
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/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/docs/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!**"
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -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/docs/README.md),
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/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/docs/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
112 changes: 112 additions & 0 deletions .github/ISSUE_TEMPLATE/3_plugin_feature_proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
name: "🔌 Plugin feature proposal"
description: Propose a plugin to be listed (featured) or bundled in al-folio.
labels: ["needs triage", "plugin-ecosystem"]
body:
- type: markdown
attributes:
value: >
Use this template to propose adding a plugin to the `al-folio` ecosystem catalog.
Featuring and bundling are separate decisions.

- type: checkboxes
id: requirements
attributes:
label: Proposal checklist
options:
- label: I confirmed this plugin is not already listed in `_data/featured_plugins.yml`.
required: true
- label: I understand that featuring does not automatically mean bundling.
required: true

- type: input
id: plugin_name
attributes:
label: Plugin name
description: Human-readable plugin name.
placeholder: al_folio_example
validations:
required: true

- type: input
id: repo_url
attributes:
label: Repository URL
description: Public repository URL for the plugin.
placeholder: https://github.com/your-org/al-folio-example
validations:
required: true

- type: input
id: gem_name
attributes:
label: Gem name
description: Name published on RubyGems.
placeholder: al_folio_example
validations:
required: true

- type: input
id: plugin_id
attributes:
label: Jekyll plugin ID
description: Plugin id used in `_config.yml` plugins list.
placeholder: al_folio_example
validations:
required: true

- type: dropdown
id: plugin_scope
attributes:
label: Plugin scope
description: Does this plugin depend on al-folio-specific runtime contracts?
options:
- Theme-coupled (al-folio-specific)
- Reusable (works outside al-folio)
validations:
required: true

- type: dropdown
id: requested_track
attributes:
label: Requested track
description: Which listing track are you proposing?
options:
- Featured-only
- Bundled in starter
validations:
required: true

- type: input
id: compatibility
attributes:
label: Compatibility range
description: al-folio versions supported by this plugin.
placeholder: "al_folio_min: 1.0.0, al_folio_max: 1.x"
validations:
required: true

- type: input
id: demo_path
attributes:
label: Demo page/post URL
description: Public demo path showing the plugin in action.
placeholder: https://your-site.example/plugins/my-plugin-demo
validations:
required: true

- type: input
id: maintainer_contact
attributes:
label: Maintainer contact
description: Primary maintainer handle or contact URL.
placeholder: https://github.com/your-handle
validations:
required: true

- type: textarea
id: notes
attributes:
label: Additional notes
description: Add context, migration notes, or caveats.
validations:
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
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/docs/README.md
about: Please consult the documentation before opening any issues!
- name: ⭐ Add your site to the showcase
url: https://github.com/alshedivat/al-folio/discussions
about: Request a listing in the Showcase category of GitHub Discussions. Entries are reviewed and added periodically — please do not open a pull request.
Loading
Loading