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: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "🐞 Bug report"
description: File a bug report
title: "[bug]: "
labels: ["bug 🐞", "triage 📑"]
labels: ["type:bug", "status:triage"]
assignees: ["ss-o"]
body:
- type: markdown
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "💡 Feature request"
description: Suggest an idea for this project
title: "[feat]: "
labels: ["feature-request 💡"]
labels: ["type:feature"]
assignees: ["ss-o"]
body:
- type: markdown
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/03_codebase_improvement.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "✨ Codebase improvement"
description: Suggest a better solution for algorithms, annexes, packages, development tools, etc.
title: "[dev]: "
labels: ["enhancement ✨"]
labels: ["type:maintenance"]
assignees: ["ss-o"]
body:
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/04_documentation.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "📚 Documentation"
description: The issue request for changes in documentation
title: "[docs]: "
labels: ["documentation 📝"]
labels: ["type:docs", "area:docs"]
assignees: ["ss-o"]
body:
- type: markdown
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/05_membership.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: "👥 Community Membership Request"
description: Request memeber privileges
labels: ["👥 member"]
description: Request member privileges
labels: ["type:membership", "area:meta"]
title: "team: "

body:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/06_agent_handoff.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "🧠 Agent handoff"
description: Record cross-agent progress, blockers, and next steps for active or deferred work.
title: "[handoff]: "
labels: ["maintenance 📈", "triage 📑", "agent-memory 🧠"]
labels: ["type:handoff", "area:meta"]
assignees: ["ss-o"]
body:
- type: markdown
Expand Down
78 changes: 39 additions & 39 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ The `.github` repository is a [special GitHub repository](https://docs.github.co

| Path | Purpose |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [`AGENTS.md`](../AGENTS.md) | Canonical org-wide instructions for AI coding agents and maintainers |
| [`PATTERNS.md`](../PATTERNS.md) | Cross-repo implementation idioms grounded in real repositories |
| [`decisions/`](../decisions/) | Architectural decision records for non-obvious org-wide choices |
| [`runbooks/`](../runbooks/) | Repeatable operational workflows such as org review, triage, ADR drafting, and release coordination |
| [`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 |
Expand All @@ -49,40 +53,33 @@ The `.github` repository is a [special GitHub repository](https://docs.github.co

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 |
| [`AGENT_MEMORY.md`](AGENT_MEMORY.md) | Cross-agent handoff and progress-tracking protocol |
| [`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 |
| [`AGENT_MEMORY.md`](AGENT_MEMORY.md) | Cross-agent handoff and progress-tracking protocol |
| [`copilot-instructions.md`](copilot-instructions.md) | Copilot entry point that defers to the canonical `AGENTS.md` |
| [`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 |
| [`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 |
Composite actions currently available to all repositories via `z-shell/.github/actions/<name>`:

| Action | Description |
| ----------------------------------- | --------------------------- |
| [`setup-zsh`](../actions/setup-zsh) | Set up Zsh for CI workflows |
| [`commit`](../actions/commit) | Commit generated changes |
| [`rclone`](../actions/rclone) | Sync files with rclone |

**Usage example:**

Expand All @@ -95,16 +92,15 @@ 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 |
| ------------- | --------------------------- |
| Trunk | Trunk code-quality workflow |
| Zsh CI | Starter Zsh CI workflow |
| Rclone Action | File sync with rclone |

Label definitions live in [`./lib/labels.yml`](lib/labels.yml) and should be applied through org maintenance scripts or API-driven automation, not via a generic starter workflow template.

Tracker and project automation should be configured at the project or owning-repository level, then documented here when it becomes a shared org convention.

## Renovate

Expand All @@ -124,7 +120,11 @@ Shared [Renovate](https://docs.renovatebot.com/) preset for automated dependency
This repository is the right place for any **organization-level** configuration:

- **Adding a new default issue/PR template** — add it to `.github/ISSUE_TEMPLATE/`
- **Updating agent instructions, ADRs, runbooks, or patterns** — edit `AGENTS.md`, `decisions/`, `runbooks/`, or `PATTERNS.md`
- **Defining weekly review, ADR, or release coordination workflows** — add or update the relevant file under `runbooks/`
- **Recording cross-agent progress** — follow `.github/AGENT_MEMORY.md` and keep active state in issues, PRs, and the Z-Shell Tracker
- **Updating the shared label set** — edit `.github/lib/labels.yml` and roll it out via the org's maintenance automation
- **Cleaning legacy labels** — follow `../runbooks/labels.md` before deleting labels from live repositories
- **Creating a reusable CI action** — add a composite action under `actions/<name>/action.yml`
- **Providing a starter workflow** — add `.yml` + `.properties.json` to `workflow-templates/`
- **Updating the organization profile** — edit `profile/README.md` or add assets to `profile/img/`
Expand Down
3 changes: 3 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Follow the canonical instructions in [`../AGENTS.md`](../AGENTS.md).

For shared progress and handoffs, also follow [`AGENT_MEMORY.md`](AGENT_MEMORY.md).
4 changes: 4 additions & 0 deletions .github/hook.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
set -eu

trunk check --show-existing --no-progress
187 changes: 82 additions & 105 deletions .github/lib/labels.yml
Original file line number Diff line number Diff line change
@@ -1,117 +1,94 @@
---
- name: "breaking-change 💥"
color: d93f0b
description: "A change that changes the API or breaks backward compatibility for users."
- name: "bug 🐞"
# Canonical organization label definitions.
# Apply these through gh/API-based maintenance automation rather than a starter workflow template.
- name: "type:bug"
color: b60205
description: "Inconsistencies or issues which will cause a problem for users or implementors."
- name: "documentation 📝"
color: 0052cc
description: "Solely about the documentation of the project."
- name: "i18n 🌐"
color: "0052cc"
description: "Internationalization"
- name: "l10n 🗣"
color: "0052cc"
description: "Localization"
- name: "enhancement ✨"
color: 006b75
description: "Enhancement of the code, not introducing new features."
- name: "refactor ♻️"
color: 006b75
description: "Simplified code that is easier to understand or more efficient syntax or methods."
- name: "performance 🚀"
color: 1d76db
description: "Improving performance of the project, not introducing new features."
- name: "new-feature 🎉"
description: "Something is broken or behaving incorrectly."
- name: "type:feature"
color: 0e8a16
description: "Introduces new feature"
- name: "security 🛡️"
color: ee0701
description: "Addressing a vulnerability or security risk in this project."
- name: "maintenance 📈"
color: 531999
description: "Generic maintenance tasks."
- name: "agent-memory 🧠"
description: "A request for new behavior or capability."
- name: "type:docs"
color: 0052cc
description: "Documentation-only work."
- name: "type:question"
color: d4c5f9
description: "Support, clarification, or usage question."
- name: "type:maintenance"
color: 531999
description: "Cross-agent handoffs, blockers, and resumable progress context."
- name: "ci 🤖"
description: "Non-feature maintenance, cleanup, or org work."
- name: "type:membership"
color: 6f42c1
description: "Membership and organization-role requests."
- name: "type:handoff"
color: 5319e7
description: "Work that improves the continuous integration."
- name: "dependencies 📦"
color: fbca04
description: "Change in project Javascript dependencies."
- name: "javascript 📦"
color: fbca04
description: "Change in project dependencies."
- name: "submodules ⚙️"
color: fbca04
description: "Change in project dependencies."
- name: "github-actions :octocat:"
color: 5319E7
description: "GitHub Actions"
description: "Cross-agent or cross-maintainer handoff context."

- name: "fix ⚡"
color: f510f4
description: "Has been fixed and is therefore considered resolved."
- name: "triage 📑"
- name: "area:zi"
color: 1d76db
description: "Zi core behavior, APIs, or documentation."
- name: "area:plugin"
color: 3e16f3
description: "Plugin behavior or plugin-facing work."
- name: "area:annex"
color: 3e16f3
description: "Annex behavior or annex-facing work."
- name: "area:package"
color: 3e16f3
description: "Package or package-management work."
- name: "area:docs"
color: 0052cc
description: "Documentation systems, content, or publishing."
- name: "area:ci"
color: 5319e7
description: "Continuous integration or GitHub Actions work."
- name: "area:dependencies"
color: fbca04
description: "The issue is awaiting investigation."
- name: "stale 👻"
color: ffffff
description: "No activity for quite some time."
- name: "no-stale 🔒"
color: fef2c0
description: "This is exempt from the stale bot"

- name: "Q&A ✍️"
color: fef2c0
description: "Questions and answers."
- name: "Poll 💌"
color: fef2c0
description: "Community vote"
- name: "invalid ⚠️"
color: 0b467f
description: "This is off-topic or incorrect."
- name: "beginner-friendly"
color: 5319E7
description: "Beginner friendy to people wanting to contribute to this project."
- name: "good first issue"
color: 5319E7
description: "Good first issue for people wanting to contribute to this project."
- name: "help-wanted"
color: 5319E7
description: "We need some extra helping hands or expertise in order to resolve this!"
- name: "feature-request 💡"
color: 0e8a16
description: "Suggests new feature."
- name: "locked ‼️"
description: "Dependency updates or dependency-management work."
- name: "area:release"
color: d93f0b
description: "Spam, inappropriate or otherwise doesn't apply to this project."
- name: "resolved ☑️"
color: 0e8a16
description: "The issue has been fixed and is therefore considered resolved."
- name: "high-priority 🔥"
description: "Release process, versioning, or changelog work."
- name: "area:meta"
color: 1d76db
description: "Organization-wide policy, templates, or meta-repo work."

- name: "priority:high"
color: ee0701
description: "Must be addressed as soon as possible."
- name: "priority-low 🔖"
description: "Needs prompt attention."
- name: "regression"
color: b60205
description: "Previously working behavior is broken."
- name: "security"
color: ee0701
description: "Security-sensitive issue or hardening work."
- name: "breaking-change"
color: d93f0b
description: "Breaks backward compatibility or changes a public contract."

- name: "status:triage"
color: fbca04
description: "Awaiting initial review or classification."
- name: "status:blocked"
color: e4e669
description: "Cannot proceed until an external dependency or decision changes."
- name: "needs-info"
color: f9d0c4
description: "Waiting on more detail before work can continue."
- name: "good first issue"
color: 7057ff
description: "Well-scoped starter task for a new contributor."
- name: "help wanted"
color: 008672
description: "Maintainers would welcome outside help."
- name: "invalid"
color: 0b467f
description: "Off-topic, incorrect, or not actionable."
- name: "duplicate"
color: cfd3d7
description: "Covered by another issue or pull request."
- name: "wontfix"
color: ffffff
description: "This issue currently can't be resolved."
description: "Acknowledged but not planned for implementation."

- name: "annex 🌀"
color: 3e16f3
description: "Related with annex"
- name: "plugin ⚙️"
color: 3e16f3
description: "Related with plugin"
- name: "package 📦"
color: 3e16f3
description: "Related with package"
- name: "major 🔺"
color: b60205
description: "This PR causes a major bump in the version number."
- name: "minor 🔸"
color: 5319e7
description: "This PR causes a minor bump in the version number."
- name: "misc ⬣"
- name: "meta:org-tracked"
color: 5319e7
description: "Auto-add this issue to the org-wide Z-Shell Tracker."
1 change: 0 additions & 1 deletion .github/workflows/dependency-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
name: "📦 Dependency Review"

on:
Comment thread
ss-o marked this conversation as resolved.
pull_request: {}
workflow_call: {}

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lychee.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ jobs:
with:
title: " 📢 Link Checker Report"
content-filepath: ./.github/LINKS_REPORT.md
labels: maintenance 📈
labels: "type:maintenance"
issue-number: 102
Loading
Loading