diff --git a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml new file mode 100644 index 0000000..6c87d88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml @@ -0,0 +1,115 @@ +name: Report a bug +description: Something is not working? Report a bug +body: + + - type: textarea + id: context + attributes: + label: Context + description: >- + This field is optional. You may provide additional context for the bug + you want to report, helping us to understand what you are working on and + what you are trying to achieve. If the context is not relevant, you can + leave this field empty. + [More](https://zensical.org/docs/community/contribute/report-a-bug/#context) + + - type: textarea + id: description + attributes: + label: Bug description + description: >- + Please give a detailed description of the bug. Explain where Zensical + Studio does not behave as you would expect it to. Be as specific as + possible. If you have found a workaround or a fix for the problem, + please let us maintainers (and all other users) know. + [More](https://zensical.org/docs/community/contribute/report-a-bug/#bug-description) + validations: + required: true + + - type: textarea + id: related-links + attributes: + label: Related links + description: >- + Please list all links to the sections of + [our documentation](https://zensical.org/studio/) that are relevant to + the bug in order to show that you have consulted and thoroughly read it. + Additionally, list links to possibly related open and closed + [issues](https://github.com/zensical/studio/issues) you encountered + when searching our issue tracker. + [More](https://zensical.org/docs/community/contribute/report-a-bug/#related-links) + value: |- + - [Report a bug](https://zensical.org/docs/community/contribute/report-a-bug/) + - + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: >- + Please create a __.zip file__ with a __minimal reproduction__ for the + bug. First, read our [reproduction guide](https://zensical.org/docs/community/guides/create-a-reproduction/) + that explains the necessary steps, then create a .zip file with the + reproduction. We reserve the right to close issues without .zip files. + [More](https://zensical.org/docs/community/contribute/report-a-bug/#reproduction) + placeholder: |- + Drag and drop the .zip file with the minimal reproduction here. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: >- + Please provide a detailed list of instructions, guiding us maintainers + through the required steps, helping us to recreate the problem using the + minimal reproduction you provided. Be as specific as possible and as + verbose as necessary – try not to leave anything out. + [More](https://zensical.org/docs/community/contribute/report-a-bug/#steps-to-reproduce) + placeholder: |- + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: dropdown + id: editor + attributes: + label: Editor + description: >- + This field is optional. If the bug only happens in a __specific editor__, + please select it from the dropdown below. If your editor is not + listed or the version is relevant, you may select _Other_ and provide + more details in the field above. + multiple: true + options: + - Visual Studio Code + + - type: checkboxes + id: checklist + attributes: + label: Before submitting + description: >- + Please ensure your bug report fulfills all of the following requirements. + If you are not sure what a specific requirement means, follow the link + to learn about it and understand why it is necessary before ticking the + box. This will save the maintainers and you valuable time. + options: + - label: >- + I have read and followed the [bug reporting guidelines](https://zensical.org/docs/community/contribute/report-a-bug/). + required: true + - label: >- + I have attached links to [the documentation](https://zensical.org/studio/), + and possibly related [issues](https://github.com/zensical/studio/issues). + required: true + - label: >- + I have attached a __.zip file__ with a [minimal reproduction](https://zensical.org/docs/community/guides/create-a-reproduction/). + required: true + - label: >- + I have read and accepted the [Zensicals Terms of Service](https://zensical.org/terms/) and the + [Zensical Studio End User License Agreement](https://github.com/zensical/studio/blob/master/EULA.md). + required: true diff --git a/.github/ISSUE_TEMPLATE/02-request-a-change.yml b/.github/ISSUE_TEMPLATE/02-request-a-change.yml new file mode 100644 index 0000000..eff5e4d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-request-a-change.yml @@ -0,0 +1,106 @@ +name: Request a change +description: Want to submit an idea? Propose a change or feature request +body: + + - type: markdown + attributes: + value: >- + Please check our [public backlog](https://github.com/orgs/zensical/projects/2) + before creating a change request. Chances are high, that your idea is already + being considered or worked on, and you can subscribe to the backlog item. + + - type: textarea + id: context + attributes: + label: Context + description: >- + This field is optional. You may provide additional context for the idea + you want to propose, helping us to understand what you are working on + and what you are trying to achieve. If the context is not relevant, you + can leave this field empty. + [More](https://zensical.org/docs/community/contribute/request-a-change/#context) + + - type: textarea + id: description + attributes: + label: Description + description: >- + Please provide a detailed description of your idea in 2-3 sentences so + that we maintainers can fully understand what change, feature, or the + improvement you are proposing. Don't yet explain the benefits of your + idea, we'll come to that. Focus on functionality. + [More](https://zensical.org/docs/community/contribute/request-a-change/#description) + validations: + required: true + + - type: textarea + id: related-links + attributes: + label: Related links + description: >- + Please list all links to open and closed [issues](https://github.com/zensical/studio/issues), + or to [documentation sections](https://zensical.org/studio/) that are + relevant to your idea. If you discussed your idea with the community on + our [Discord channel](https://discord.gg/hqXRNq9CjT) prior to creating + this change request, please link the discussion here as well. + [More](https://zensical.org/docs/community/contribute/request-a-change/#related-links) + value: |- + - [Requesting a change](https://zensical.org/docs/community/contribute/request-a-change/) + - + validations: + required: true + + - type: textarea + id: use-cases + attributes: + label: Use Cases + description: >- + Please explain how your idea will work from an author's and user's + perspective. Elaborate on how the change would positively impact not only + you but our community and how it aligns with the goals and [our roadmap](https://zensical.org/studio/about/roadmap/). + [More](https://zensical.org/docs/community/contribute/request-a-change/#use-cases) + validations: + required: true + + - type: textarea + id: visuals + attributes: + label: Visuals + description: >- + This field is optional. You may provide sketches, screenshots, mockups, + or external assets to illustrate your idea. If you have seen this change, + feature, or improvement used in other static site generators or themes, + please describe how it is implemented and advertised. + [More](https://zensical.org/docs/community/contribute/request-a-change/#visuals) + placeholder: |- + Drag and drop images here or link external assets. + + - type: checkboxes + id: checklist + attributes: + label: Before submitting + description: + Please ensure your idea fulfills all of the following requirements. If + you need clarification on a specific requirement, follow the link to + learn about it and understand why it is necessary before ticking the box. + This will save the maintainers and you valuable time. + options: + - label: >- + I have read and followed the [change request guidelines](https://zensical.org/docs/community/contribute/request-a-change/). + required: true + - label: >- + I have verified that [my idea is a change request and not a bug report](https://zensical.org/docs/community/contribute/request-a-change/#its-not-a-bug-its-a-feature). + required: true + - label: >- + I have ensured that, to the best of my knowledge, my idea will + benefit the entire community. + required: true + - label: >- + I have included relevant links to [the documentation](https://zensical.org/studio/), + related [issues](https://github.com/zensical/studio/issues) or + Discord discussions, to underline the need for my idea. + required: true + - label: >- + I have read and accepted the [Zensicals Terms of Service](https://zensical.org/terms/) + and the [Zensical Studio End User License Agreement](https://github.com/zensical/studio/blob/master/EULA.md). + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8886753 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,41 @@ +# Copyright (c) 2025-2026 Zensical and contributors + +# SPDX-License-Identifier: MIT +# All contributions are certified under the DCO + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +blank_issues_enabled: false +contact_links: + - name: Report a documentation issue + url: https://github.com/zensical/docs/issues/new?template=01-report-a-docs-issue.yml + about: > + Missing information in our docs? Report a documentation issue + + - name: Ask a question + url: https://discord.gg/hqXRNq9CjT + about: > + Have a question or need help? Connect with our community on our + Discord channel + + - name: Get professional support + url: https://zensical.org/spark/ + about: > + Need help with Zensical? Get professional support directly from the + Zensical team