Skip to content

Improve documentation, workflows, and optimize SVG files #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ss-o wants to merge 1 commit into from
+62 −166
Closed

Improve documentation, workflows, and optimize SVG files #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
100 changes: 50 additions & 50 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,66 +21,66 @@ The `.github` repository is a [special GitHub repository](https://docs.github.co

### What Makes It Special

| Feature | How It Works |
| --- | --- |
| **Organization Profile** | `profile/README.md` is rendered on the [organization's GitHub page](https://github.com/z-shell) as the public-facing profile. |
| **Default Community Health Files** | Files like `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, and `GOVERNANCE.md` in `.github/` are used as fallbacks by any org repository that doesn't define its own. |
| **Default Issue & PR Templates** | Templates in `.github/ISSUE_TEMPLATE/` and discussion forms in `.github/DISCUSSION_TEMPLATE/` are inherited by repositories without their own templates. |
| **Reusable Composite Actions** | The `actions/` directory hosts [composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that any org repository can reference via `uses: z-shell/.github/actions/<name>@main`. |
| **Workflow Templates** | The `workflow-templates/` directory provides [starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization) available in every org repository under **Actions > New workflow**. |
| **Shared Dependency Config** | `renovate-config.json` defines a shared [Renovate](https://docs.renovatebot.com/) preset that org repositories can extend for consistent automated dependency updates. |
| Feature | How It Works |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Organization Profile** | `profile/README.md` is rendered on the [organization's GitHub page](https://github.com/z-shell) as the public-facing profile. |
| **Default Community Health Files** | Files like `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `SECURITY.md`, and `GOVERNANCE.md` in `.github/` are used as fallbacks by any org repository that doesn't define its own. |
| **Default Issue & PR Templates** | Templates in `.github/ISSUE_TEMPLATE/` and discussion forms in `.github/DISCUSSION_TEMPLATE/` are inherited by repositories without their own templates. |
| **Reusable Composite Actions** | The `actions/` directory hosts [composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) that any org repository can reference via `uses: z-shell/.github/actions/<name>@main`. |
| **Workflow Templates** | The `workflow-templates/` directory provides [starter workflows](https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization) available in every org repository under **Actions > New workflow**. |
| **Shared Dependency Config** | `renovate-config.json` defines a shared [Renovate](https://docs.renovatebot.com/) preset that org repositories can extend for consistent automated dependency updates. |

> **Note:** The `.github` repository must be **public** for default community health files to apply across the organization.

---

## Repository Structure

| Path | Purpose |
| --- | --- |
| [`profile/`](../profile/) | Organization profile — the README and visual assets displayed on the [org page](https://github.com/z-shell) |
| [`actions/`](../actions/) | Reusable composite GitHub Actions shared across all org repositories |
| [`workflow-templates/`](../workflow-templates/) | Starter workflow templates available in the **Actions > New workflow** tab |
| [`metrics/`](../metrics/) | Auto-generated organization metrics and analytics |
| [`renovate-config.json`](../renovate-config.json) | Shared Renovate bot preset for dependency updates |
| Path | Purpose |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [`profile/`](../profile/) | Organization profile — the README and visual assets displayed on the [org page](https://github.com/z-shell) |
| [`actions/`](../actions/) | Reusable composite GitHub Actions shared across all org repositories |
| [`workflow-templates/`](../workflow-templates/) | Starter workflow templates available in the **Actions > New workflow** tab |
| [`metrics/`](../metrics/) | Auto-generated organization metrics and analytics |
| [`renovate-config.json`](../renovate-config.json) | Shared Renovate bot preset for dependency updates |

### Community Health Files

These files in `.github/` act as **organization-wide defaults** — automatically used by any repository that doesn't have its own version:

| File | Purpose |
| --- | --- |
| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Contributor Covenant code of conduct |
| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Contribution guidelines and requirements |
| [`SECURITY.md`](SECURITY.md) | Security vulnerability reporting policy |
| [`GOVERNANCE.md`](GOVERNANCE.md) | Project governance roles and decision-making |
| [`CHARTER.md`](CHARTER.md) | Organizational charter and mission |
| [`STEERING_COMMITTEE.md`](STEERING_COMMITTEE.md) | Steering committee membership |
| [`MAINTAINERS.md`](MAINTAINERS.md) | Project maintainer list |
| [`TRADEMARKS.md`](TRADEMARKS.md) | Trademark usage policy |
| [`ANTITRUST.md`](ANTITRUST.md) | Antitrust compliance policy |
| [`ISSUE_TEMPLATE/`](ISSUE_TEMPLATE/) | Default issue forms (bug reports, features, docs, membership) |
| [`DISCUSSION_TEMPLATE/`](DISCUSSION_TEMPLATE/) | Default discussion category forms |
| File | Purpose |
| ------------------------------------------------ | ------------------------------------------------------------- |
| [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) | Contributor Covenant code of conduct |
| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Contribution guidelines and requirements |
| [`SECURITY.md`](SECURITY.md) | Security vulnerability reporting policy |
| [`GOVERNANCE.md`](GOVERNANCE.md) | Project governance roles and decision-making |
| [`CHARTER.md`](CHARTER.md) | Organizational charter and mission |
| [`STEERING_COMMITTEE.md`](STEERING_COMMITTEE.md) | Steering committee membership |
| [`MAINTAINERS.md`](MAINTAINERS.md) | Project maintainer list |
| [`TRADEMARKS.md`](TRADEMARKS.md) | Trademark usage policy |
| [`ANTITRUST.md`](ANTITRUST.md) | Antitrust compliance policy |
| [`ISSUE_TEMPLATE/`](ISSUE_TEMPLATE/) | Default issue forms (bug reports, features, docs, membership) |
| [`DISCUSSION_TEMPLATE/`](DISCUSSION_TEMPLATE/) | Default discussion category forms |

---

## Shared Actions

Composite actions available to all repositories via `z-shell/.github/actions/<name>`:

| Action | Description |
| --- | --- |
| [`setup-zsh`](../actions/setup-zsh) | Set up Zsh environment for CI |
| Action | Description |
| ----------------------------------------------------------- | ---------------------------------- |
| [`setup-zsh`](../actions/setup-zsh) | Set up Zsh environment for CI |
| [`setup-zsh-development`](../actions/setup-zsh-development) | Set up Zsh development environment |
| [`build-zpmod-module`](../actions/build-zpmod-module) | Build the Zpmod Zsh module |
| [`test-zpmod-module`](../actions/test-zpmod-module) | Test the Zpmod module |
| [`test-zsh-module`](../actions/test-zsh-module) | Test Zsh modules |
| [`commit`](../actions/commit) | Automated commit action |
| [`rebase`](../actions/rebase) | Automated rebase action |
| [`mirror`](../actions/mirror) | Repository mirroring |
| [`rclone`](../actions/rclone) | File sync with rclone |
| [`determine-branch`](../actions/determine-branch) | Determine target branch |
| [`verify-pr-labels`](../actions/verify-pr-labels) | Verify PR label compliance |
| [`build-zpmod-module`](../actions/build-zpmod-module) | Build the Zpmod Zsh module |
| [`test-zpmod-module`](../actions/test-zpmod-module) | Test the Zpmod module |
| [`test-zsh-module`](../actions/test-zsh-module) | Test Zsh modules |
| [`commit`](../actions/commit) | Automated commit action |
| [`rebase`](../actions/rebase) | Automated rebase action |
| [`mirror`](../actions/mirror) | Repository mirroring |
| [`rclone`](../actions/rclone) | File sync with rclone |
| [`determine-branch`](../actions/determine-branch) | Determine target branch |
| [`verify-pr-labels`](../actions/verify-pr-labels) | Verify PR label compliance |

**Usage example:**

Expand All @@ -93,16 +93,16 @@ steps:

Starter workflows available in every org repository under **Actions > New workflow**:

| Template | Description |
| --- | --- |
| Commit Action | Automated commit workflow |
| Rebase Action | PR auto-rebase workflow |
| Lock Action | Issue/PR auto-lock |
| Stale Action | Stale issue management |
| Trunk | Trunk.io linting integration |
| Sync Labels | Label synchronization |
| Verify PR Labels | PR label validation |
| Rclone Action | File sync with rclone |
| Template | Description |
| ---------------- | ---------------------------- |
| Commit Action | Automated commit workflow |
| Rebase Action | PR auto-rebase workflow |
| Lock Action | Issue/PR auto-lock |
| Stale Action | Stale issue management |
| Trunk | Trunk.io linting integration |
| Sync Labels | Label synchronization |
| Verify PR Labels | PR label validation |
| Rclone Action | File sync with rclone |

## Renovate

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/gh-deploy-assets.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: "🚀 Deploy Assets"
on:
push:
branches: [main]
paths: ["./profile/**", "!.metrics/"]
paths: ["profile/**", "!.metrics/"]
workflow_dispatch: {}

permissions: read-all
Expand Down
14 changes: 7 additions & 7 deletions .trunk/trunk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ lint:
- trufflehog
- yamllint
- vale
- ruff
enabled:
- oxipng@10.1.0
- bandit@1.9.4
- ruff@0.15.11
- taplo@0.10.0
- isort@8.0.1
- flake8@7.3.0
Expand All @@ -43,14 +43,14 @@ lint:
- linters: [svgo]
paths:
- "metrics/**"
- linters: [markdownlint]
paths:
- ".github/styles/**"
# - linters: [markdownlint]
# paths:
# - ".github/styles/**"
runtimes:
enabled:
- python@3.10.8
- go@1.21.0
- node@22.16.0
- python@3.13.3
- go@1.24.0
- node@23.8.0
actions:
disabled:
- trunk-check-pre-push
Expand Down
29 changes: 1 addition & 28 deletions profile/img/card-community.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 1 addition & 28 deletions profile/img/card-ecosystem.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading