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
351 changes: 2 additions & 349 deletions .editorconfig

Large diffs are not rendered by default.

89 changes: 9 additions & 80 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,82 +1,11 @@
# Auto detect text files and perform LF normalization
* text=auto
* text=auto

#
# The above will handle all files NOT found below
#
*.sh text eol=lf
*.zsh text eol=lf
*.zunit text eol=lf
_zi text eol=lf
lib/zcompile text eol=lf
lib/templates/example-script text eol=lf

# Documents
*.bibtex text diff=bibtex
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
*.md text diff=markdown
*.mdx text diff=markdown
*.tex text diff=tex
*.adoc text
*.textile text
*.mustache text
*.csv text
*.tab text
*.tsv text
*.txt text
*.sql text
*.epub diff=astextplain

# Graphics
*.png binary
*.jpg binary
*.jpeg binary
*.gif binary
*.tif binary
*.tiff binary
*.ico binary
# SVG treated as text by default.
*.svg text
# If you want to treat it as binary,
# use the following line instead.
# *.svg binary
*.eps binary

# Scripts
*.bash text eol=lf
*.fish text eol=lf
*.sh text eol=lf
*.zsh text eol=lf
*.zunit text eol=lf
# These are explicitly windows files and should use crlf
*.bat text eol=crlf
*.cmd text eol=crlf
*.ps1 text eol=crlf

# Serialisation
*.json text
*.toml text
*.xml text
*.yaml text
*.yml text

# Archives
*.7z binary
*.gz binary
*.tar binary
*.tgz binary
*.zip binary

# Text files where line endings should be preserved
*.patch -text

#
# Exclude files from exporting
#

.gitattributes export-ignore
.gitignore export-ignore
.gitkeep export-ignore
*.gz binary
*.png binary
98 changes: 19 additions & 79 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,110 +1,50 @@
name: "🐞 Bug report"
description: File a bug report
description: Report reproducible incorrect Zi behavior
title: "[bug]: "
labels: ["bug 🐞", "triage 📑"]
labels: ["type:bug", "status:triage"]
assignees: ["ss-o"]
body:
- type: markdown
attributes:
value: |
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
- type: input
id: environment
attributes:
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
id: repro
attributes:
label: Reproduction steps
description: "How do you trigger this bug? Please walk us through it step by step."
value: |
1.
2.
3.
4.
5.
...
render: bash
description: Include your OS, Zsh version, and Zi commit.
placeholder: zsh --version; git -C "${ZI[BIN_DIR]}" rev-parse HEAD
validations:
required: true
- type: textarea
id: expected
id: reproduction
attributes:
label: Expected behavior
description: "Please describe the expected behavior"
value: |
1.
2.
3.
4.
5.
...
render: bash
label: Minimal reproduction
description: Provide the smallest Zsh commands or configuration that reproduce the problem.
render: zsh
validations:
required: true
- type: textarea
id: current
id: actual
attributes:
label: Current behavior
description: "Please describe how the bug manifests"
value: |
1.
2.
3.
4.
5.
...
render: bash
label: Actual behavior
description: Include complete error output or logs where relevant.
validations:
required: true
- type: textarea
id: code-snippet
attributes:
label: Code snippet
description: "Please insert your zshrc or just a short code snippet in concern."
validations:
required: true
- type: textarea
id: additional
id: expected
attributes:
label: Additional information
description: "List any other information that is relevant to your issue. For reports and stats run `zi analytics`"
label: Expected behavior
validations:
required: true
- type: checkboxes
id: self-service
attributes:
label: Self-service
description: |
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 would be willing to submit a fix for this bug.
- type: checkboxes
id: policies
attributes:
label: Have you read the Contributing Guidelines?
label: Project policies
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 [contribution 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 agree to follow the [Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
56 changes: 18 additions & 38 deletions .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,61 +1,41 @@
name: "💡 Feature request"
description: Suggest an idea for this project
description: Propose a new Zi capability
title: "[feat]: "
labels: ["feature-request 💡"]
labels: ["type:feature", "status:triage"]
assignees: ["ss-o"]
body:
- type: markdown
attributes:
value: |
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
- type: input
id: description
- type: textarea
id: problem
attributes:
label: Feature description
description: A clear and concise description of what the feature request is. Please include if your feature request is related to a problem
label: Problem
description: What Zi use case is difficult or impossible today?
validations:
required: true
- type: textarea
id: code-snippet
id: proposal
attributes:
label: Related Code
description: "If you can illustrate the bug or feature request with an example, please provide it here"
label: Proposed solution
description: Describe the behavior and show an example Zi command or configuration.
validations:
required: false
required: true
- type: textarea
id: additional
id: alternatives
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."
label: Alternatives considered
validations:
required: false
- type: checkboxes
id: self-service
attributes:
label: Self-service
description: |
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 would be willing to implement this feature.
- type: checkboxes
id: policies
attributes:
label: Have you read the Contributing Guidelines?
label: Project policies
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 [contribution 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 agree to follow the [Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
49 changes: 19 additions & 30 deletions .github/ISSUE_TEMPLATE/03_codebase_improvement.yml
Original file line number Diff line number Diff line change
@@ -1,46 +1,35 @@
name: "✨ Codebase improvement"
description: Suggest a better solution for algorithms, annexes, packages, development tools, etc.
title: "[dev]: "
labels: ["enhancement ✨"]
description: Propose maintenance or an improvement to existing Zi code
title: "[chore]: "
labels: ["type:maintenance", "status:triage"]
assignees: ["ss-o"]
body:
- type: textarea
id: enhancement
id: limitation
attributes:
label: "Your feedback for the existing codebase"
label: Current limitation
description: Identify the code, tooling, or workflow that should be improved.
validations:
required: false
- type: markdown
required: true
- type: textarea
id: proposal
attributes:
value: |
First off, thanks for taking the time to contribute!
Contributions are what make the open-source community such an amazing place to learn, inspire, and create.
Any contributions you make will benefit everybody else and are greatly appreciated.
label: Proposed improvement
description: Explain the change and its expected benefit or trade-offs.
validations:
required: true
- type: checkboxes
id: self-service
attributes:
label: Self-service
description: |
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 would be willing to implement this improvement.
- type: checkboxes
id: policies
attributes:
label: Have you read the Contributing Guidelines?
label: Project policies
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 [contribution 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 agree to follow the [Code of Conduct](https://github.com/z-shell/.github/blob/main/.github/CODE_OF_CONDUCT.md).
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
Loading
Loading