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
10 changes: 4 additions & 6 deletions .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 All @@ -14,13 +14,11 @@ body:
label: Environment
description: >
Please describe your environment in as much detail as possible. Otherwise, we may not be able to reproduce the issue.

placeholder: >
Example:
print "Device: $VENDOR | $OSTYPE | $CPUTYPE"
print "Shell: $SHELL | $ZSH_ARGZERO | $ZSH_PATCHLEVEL"
print "Zi: $(git -C $ZI[BIN_DIR] rev-parse HEAD)"

validations:
required: true
- type: textarea
Expand Down Expand Up @@ -89,18 +87,18 @@ body:
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to address this documentation request myself.
- label: I'd be willing to fix this bug myself.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines?
options:
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/community/blob/main/docs/CONTRIBUTING_GUIDELINES.md).
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/.github/blob/main/.github/CONTRIBUTING.md).
required: true
- type: checkboxes
attributes:
label: Are you familiar with the Contributor Covenant Code of Conduct?
options:
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/zi/blob/main/docs/CODE_OF_CONDUCT.md).
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
Expand Down
12 changes: 7 additions & 5 deletions .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 All @@ -26,7 +26,9 @@ body:
id: additional
attributes:
label: Additional Context
description: "List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc."
description:
"List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable,
etc."
validations:
required: false
- type: checkboxes
Expand All @@ -36,18 +38,18 @@ body:
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to address this documentation request myself.
- label: I'd be willing to implement this feature myself.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines?
options:
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/community/blob/main/docs/CONTRIBUTING_GUIDELINES.md).
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/.github/blob/main/.github/CONTRIBUTING.md).
required: true
- type: checkboxes
attributes:
label: Are you familiar with the Contributor Covenant Code of Conduct?
options:
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/zi/blob/main/docs/CODE_OF_CONDUCT.md).
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
Expand Down
8 changes: 4 additions & 4 deletions .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 All @@ -23,18 +23,18 @@ body:
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to address this documentation request myself.
- label: I'd be willing to make this improvement myself.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines?
options:
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/community/blob/main/docs/CONTRIBUTING_GUIDELINES.md).
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/.github/blob/main/.github/CONTRIBUTING.md).
required: true
- type: checkboxes
attributes:
label: Are you familiar with the Contributor Covenant Code of Conduct?
options:
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/zi/blob/main/docs/CODE_OF_CONDUCT.md).
- label: I have read the [Contributor Covenant Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
Expand Down
6 changes: 3 additions & 3 deletions .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 Expand Up @@ -31,7 +31,7 @@ body:
label: Select the area that is associated with this issue.
multiple: true
options:
- ZI (this repository)
- General
- Annexes
- Plugins
- Packages
Expand All @@ -48,7 +48,7 @@ body:
attributes:
label: Have you read the Contributing Guidelines?
options:
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/community/blob/main/docs/CONTRIBUTING_GUIDELINES.md).
- label: I have read the [Contributing Guidelines](https://github.com/z-shell/.github/blob/main/.github/CONTRIBUTING.md).
required: true
- type: checkboxes
attributes:
Expand Down
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/05_membership.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: "👥 Community Membership Request"
description: Request member privileges
labels: ["type:membership", "area:meta"]
title: "team: "

body:
- type: markdown
attributes:
value: |
Thanks for participating!
- type: input
attributes:
label: Username
description: GitHub username for the membership request.
placeholder: ex. @username
validations:
required: true
- type: input
id: contact
attributes:
label: Email
description: Public email
placeholder: ex. email@example.com
validations:
required: false
- type: checkboxes
id: email-fwd
attributes:
label: Assign @zshell.dev email forwarder
description: Email with GitHub username and @zshell.dev domain to be used when participating (ex. username@zshell.dev).
options:
- label: Assign email
required: false
- type: input
attributes:
label: Sponsors
description: GitHub usernames of sponsors if any.
placeholder: "@sponsor1, @sponsor2"
validations:
required: false
- type: dropdown
id: property
attributes:
label: "Property you are interested or would like to moderate."
options:
- General
- Annexes
- Plugins
- Packages
- Community
- Social media
- Documentation
- Technical writing
- Internationalization
- Other - described below
- type: textarea
attributes:
label: According to the selection above, please describe your role from your point of view.
description: >
Please try to describe in detail as much as possible, your role in the organization, daily routines,
what achievements you would set yourself, and what steps you would take. Any example is valid
validations:
required: true
- type: textarea
attributes:
label: Organization support
description: >
Please try to describe in detail as much as possible, your role in the organization, daily routines,
what achievents you would set yourself and what steps you would take. Any example is valid
validations:
required: false
- type: textarea
attributes:
label: Additional
description: Optional textarea to provide any additional information.
validations:
required: false
- type: checkboxes
id: contributing
attributes:
label: Governance & Steering committee.
description: >
By submitting this issue, you confirm to agree with [Organizational Governance and Policies for a Technical Steering Committee (TSC)](https://github.com/z-shell/.github/blob/main/governance/README.md)
options:
- label: "I am familiar with and agree with the governance & technical steering committee."
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: >
By submitting this issue, you agree to follow and will cultivate the [Code of Conduct](https://github.com/z-shell/.github/main/governance/organization/CODE-OF-CONDUCT.md)
options:
- label: "I agree to sustain healthy interactions and will follow this project's Code of Conduct"
required: true
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/06_agent_handoff.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: "🧠 Agent handoff"
description: Record cross-agent progress, blockers, and next steps for active or deferred work.
title: "[handoff]: "
labels: ["type:handoff", "area:meta"]
assignees: ["ss-o"]
body:
- type: markdown
attributes:
value: |
Use this only for work that needs shared context between maintainers or LLM agents.
If the work is a bug, feature, or documentation request, prefer the specific template and add the handoff details there.
- type: input
id: repository
attributes:
label: Repository
description: Owning repository for this work.
placeholder: z-shell/<repo>
validations:
required: true
- type: input
id: branch-pr
attributes:
label: Branch or pull request
description: Branch name, pull request URL, or both.
placeholder: feature-example, https://github.com/z-shell/<repo>/pull/123
validations:
required: false
- type: dropdown
id: status
attributes:
label: Status
options:
- Planned
- In progress
- Blocked
- Ready for review
- Complete
validations:
required: true
- type: textarea
id: current-state
attributes:
label: Current state
description: What is true now? Include completed work and important decisions.
placeholder: |
- ...
validations:
required: true
- type: textarea
id: verification
attributes:
label: Verification
description: Commands, checks, CI runs, or review performed. Say "Not run" if nothing was run.
placeholder: |
- automation/ci/trunk-safe-check.sh -- check --no-fix: passed
- CI: pending
validations:
required: true
- type: textarea
id: blockers
attributes:
label: Blockers
description: Anything preventing completion. Write "None" if unblocked.
placeholder: None
validations:
required: true
- type: textarea
id: next-steps
attributes:
label: Next steps
description: Exact next actions for a fresh maintainer or agent.
placeholder: |
1. ...
2. ...
validations:
required: true
- type: textarea
id: links
attributes:
label: Links
description: Related issues, pull requests, tracker items, CI runs, or wiki pages.
placeholder: |
- ...
validations:
required: false
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/07_delivery_initiative.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: "Delivery initiative"
description: >-
Coordinate a cross-repository outcome through native sub-issues.
title: "[initiative]: "
labels:
- "type:maintenance"
- "area:meta"
- "status:triage"
- "meta:initiative"
- "meta:org-tracked"
body:
- type: markdown
attributes:
value: |
Use this form only for one coordinated outcome with at least two
independently deliverable issues in different repositories. After
creating the parent, create or connect each deliverable as a native
sub-issue. Follow the [sub-issues runbook](https://github.com/z-shell/.github/blob/main/runbooks/sub-issues.md).
- type: textarea
id: outcome
attributes:
label: Outcome
description: >-
State the coordinated result and who benefits when it is complete.
placeholder: One observable outcome, not a topic or task list.
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: >-
Explain why the outcome matters and why coordination is needed now.
validations:
required: true
- type: textarea
id: deliverables
attributes:
label: Expected deliverables
description: >-
Name the independently deliverable results and their owning
repositories. Connect their issues as native sub-issues after creating
this parent.
placeholder: |
- z-shell/<repo>: <deliverable>
- z-shell/<repo>: <deliverable>
validations:
required: true
- type: textarea
id: dependencies
attributes:
label: Dependencies and risks
description: >-
Identify known blockers or execution order. Use native issue
dependencies after the related issues exist.
placeholder: None known.
validations:
required: true
- type: textarea
id: completion
attributes:
label: Completion criteria
description: >-
State how maintainers will verify the coordinated outcome before
closing this parent.
placeholder: |
- [ ] Observable outcome verified
- [ ] Required deliverables complete or explicitly descoped
validations:
required: true
Loading