Skip to content

Commit

Permalink
chore(git) Add plugin’s issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Zykino committed Sep 23, 2024
1 parent 3569daf commit 40a0db2
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/plugin_API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Plugin API
about: You are developping a plugin and need something
title: ''
labels: plugin-api
assignees: ''

---

<!--
Note on new features: while Zellij tries to be as user friendly as possible, it must also be friendly to its maintainers. We take great care in considering which features should be included in the core Zellij functionality - because each such feature means more maintenance overhead for the project.
We know our users care about the program a great deal and would like to see it improve. For this reason, we try to make an effort to allow users to develop their desired new features as Zellij plugins (https://zellij.dev/documentation/plugins).
** Note on comparisons to tmux: Zellij is not, nor does it try to be, a tmux clone. While we appreciate that many people use it as a tmux alternative and are missing their favorite features - this is not what we do here. There are often native alternatives to tmux features that Zellij does differently. We would encourage you to look into those alternatives rather than try to make it work exactly like tmux. A good place to start would be our FAQ: https://zellij.dev/documentation/faq
We believe each program has its strengths and weaknesses, and hope that users would want to use Zellij for what it can do, rather than trying to make it behave like something it does not want to be. Thank you for understanding! **
Please select the correct option and remove the unused ones.
-->

1. I have a problem with current APIs

2. I need a new API

3. I have a question
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/plugin_idea.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: "💡 Plugin idea"
about: I would love if the community could bring a feature to life
title: ''
labels: plugin-community-idea
assignees: ''

---

<!--
Note on new features: while Zellij tries to be as user friendly as possible, it must also be friendly to its maintainers. We take great care in considering which features should be included in the core Zellij functionality - because each such feature means more maintenance overhead for the project.
We know our users care about the program a great deal and would like to see it improve. For this reason, we try to make an effort to allow users to develop their desired new features as Zellij plugins (https://zellij.dev/documentation/plugins).
** Note on comparisons to tmux: Zellij is not, nor does it try to be, a tmux clone. While we appreciate that many people use it as a tmux alternative and are missing their favorite features - this is not what we do here. There are often native alternatives to tmux features that Zellij does differently. We would encourage you to look into those alternatives rather than try to make it work exactly like tmux. A good place to start would be our FAQ: https://zellij.dev/documentation/faq
We believe each program has its strengths and weaknesses, and hope that users would want to use Zellij for what it can do, rather than trying to make it behave like something it does not want to be. Thank you for understanding! **
-->

# General description
<!-- I would like to be able to … -->

# Uses cases
<!-- 1. With a keybinding I would like to … -->

<!-- 2. From a pipe it will … -->

0 comments on commit 40a0db2

Please sign in to comment.