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
121 changes: 121 additions & 0 deletions .github/ISSUE_TEMPLATE/01-report-a-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
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
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/docs/) 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/zensical/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: browser
attributes:
label: Browser
description: >-
This field is optional. If the bug only happens in __specific browsers__,
please select them from the dropdown below. If your browser is not
listed or the version is relevant, you may select _Other_ and provide
more details in the field above.
[More](https://zensical.org/docs/community/contribute/report-a-bug/#browser)
multiple: true
options:
- Chrome
- Safari
- Edge
- Firefox
- Opera
- Other

- 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/docs/),
and possibly related [issues](https://github.com/zensical/zensical/issues).
required: true
- label: >-
I assure that I have [removed all customizations](https://zensical.org/docs/community/contribute/report-a-bug/#remove-customizations)
before submitting this bug report.
required: true
- label: >-
I have attached a __.zip file__ with a [minimal reproduction](https://zensical.org/docs/community/guides/create-a-reproduction/).
required: true
101 changes: 101 additions & 0 deletions .github/ISSUE_TEMPLATE/02-request-a-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
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/zensical/issues),
or to [documentation sections](https://zensical.org/docs/) 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 [vision](https://zensical.org/about/vision/)
of the project.
[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/docs/) and related [issues](https://github.com/zensical/zensical/issues),
to underline the need for my idea.
required: true
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--
Before opening a PR, please read our contributing guide:
https://zensical.org/docs/community/contribute/pull-requests/
-->

## Summary

<!-- Briefly describe what this PR does and why -->

## Related issue

<!-- Every PR from an outside contributor must be linked to an issue -->

This pull request is linked to the following issue:

## Checklist

<!-- All boxes must be checked -->

Please ensure that your PR meets the following requirements:

- [ ] I have read the [pull request guide] and confirm it meets all outlined requirements
- [ ] I have created an issue to discuss the change and received agreement from maintainers to proceed
- [ ] I have [cryptographically signed] all commits and included a `Signed-off-by` trailer, accepting the [DCO]
- [ ] I have written or reviewed every line of code myself and can fully explain it – see our policy on [use of Generative AI]

[pull request guide]: https://zensical.org/docs/community/contribute/pull-requests/
[cryptographically signed]: https://zensical.org/docs/community/contribute/pull-requests/#verified-commits
[DCO]: https://zensical.org/docs/community/contribute/pull-requests/#developer-certificate-of-origin
[use of Generative AI]: https://zensical.org/docs/community/contribute/pull-requests/#use-of-generative-ai
Loading