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
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
blank_issues_enabled: false
contact_links: []
41 changes: 41 additions & 0 deletions .github/workflows/self-showcase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Refresh README Preview

# Dogfoods this repo's own action: renders the maintainer's real
# contribution constellation and commits it into docs/, so the hero image
# in README.md is a genuinely live, self-updating render — not a static
# placeholder. Anyone can verify this by checking the commit history on
# docs/constellation-dark.svg.

on:
schedule:
- cron: "0 3 * * *" # once a day
workflow_dispatch: {}
push:
branches: [main]
paths:
- "src/generate-constellation.js"
- "action.yml"

permissions:
contents: write

jobs:
showcase:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Generate maintainer's own constellation (dogfooding)
uses: ./
with:
github_user: m3hrab
github_token: ${{ secrets.SHOWCASE_TOKEN }}
output_dir: docs

- name: Commit and push if changed
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add docs/
git diff --staged --quiet || git commit -m "chore: refresh README preview constellation"
git push
24 changes: 17 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,29 @@ branch and reference it from a scratch workflow/repo:
github_token: ${{ secrets.GITHUB_TOKEN }}
```

### About the self-showcase workflow

`.github/workflows/self-showcase.yml` is maintainer-only tooling — it runs
this repo's own action against the maintainer's real GitHub profile and
commits the result into `docs/`, which is what makes the hero image in
`README.md` a genuinely live render instead of a static placeholder. It
needs a `SHOWCASE_TOKEN` repository secret to run. Contributors don't need
this secret and can ignore this workflow entirely — it won't run on PRs
from forks.

## Branch naming

```
<type>/<short-description>
```

| Type | Use for | Example |
| ----------- | ------------------------------- | --------------------------------- |
| `feat/` | new feature | `feat/minimal-layout-option` |
| `fix/` | bug fix | `fix/light-theme-color-parsing` |
| `docs/` | docs only | `docs/inputs-table-typo` |
| `chore/` | tooling, CI, deps | `chore/bump-setup-node-v5` |
| `refactor/` | no behavior change | `refactor/extract-svg-builder` |
| Type | Use for | Example |
| ----------- | ------------------ | ------------------------------- |
| `feat/` | new feature | `feat/minimal-layout-option` |
| `fix/` | bug fix | `fix/light-theme-color-parsing` |
| `docs/` | docs only | `docs/inputs-table-typo` |
| `chore/` | tooling, CI, deps | `chore/bump-setup-node-v5` |
| `refactor/` | no behavior change | `refactor/extract-svg-builder` |

Lowercase, hyphens (not underscores), 2–5 words. Issue numbers go in the PR
description, not the branch name.
Expand Down
Loading
Loading