From af56740d3137bb5aad3bcf425e9090f133b11894 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 13 Apr 2026 13:11:50 +0100 Subject: [PATCH] chore: add guides and templates Signed-off-by: squidfunk --- .github/ISSUE_TEMPLATE/01-report-a-bug.yml | 121 ++++++++++++++++++ .../ISSUE_TEMPLATE/02-request-a-change.yml | 101 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 41 ++++++ .github/pull_request_template.md | 30 +++++ CODE_OF_CONDUCT.md | 87 +++++++++++++ CONTRIBUTING.md | 32 +++++ SECURITY.md | 33 +++++ 7 files changed, 445 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-report-a-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/02-request-a-change.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md 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 00000000..a3dcb33c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml @@ -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 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 00000000..f901484b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-request-a-change.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..88867530 --- /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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..9544b6e6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ + + +## Summary + + + +## Related issue + + + +This pull request is linked to the following issue: + +## Checklist + + + +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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b43aee28 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,87 @@ +# Contributor Covenant – Code of Conduct + +## Our pledge + +We pledge to make our community welcoming, safe, and equitable for all. + +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. + +## Encouraged behaviors + +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. + +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: + +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. + +## Restricted behaviors + +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. + +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. + +### Other restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + +## Reporting an issue + +Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. To report a possible violation, reach out to hello@zensical.org with the following information: + +1. A description of the incident, including what happened, when and where it occurred, and any other relevant details. +2. The names or usernames of the people involved, including any witnesses. +3. Any evidence you have, such as screenshots, logs, or recordings. + +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. + +## Addressing and repairing harm + +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. + +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) + +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c4d6e6d4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +Zensical is an actively maintained and constantly improved project that serves a diverse user base with varying backgrounds and needs. We genuinely appreciate every contribution, whether it's reporting a bug, suggesting an improvement, or helping others in the community. + +To make it as easy as possible to contribute, we have put significant effort into creating clear templates for [our issue tracker]. We want to make sure all the information we need is there from the start, so we can focus on what matters: building the best possible product together. + +[our issue tracker]: https://github.com/zensical/zensical/issues + +## How to contribute + +Whether you want to report a bug, suggest an improvement, or help others in the community, each of these processes is covered in detail in [our documentation]. Find whatever fits your situation in the list below: + +[our documentation]: https://zensical.org/docs/ + +- [Ask a question](https://zensical.org/docs/community/get-involved/#discord) +- [Report a bug](https://zensical.org/docs/community/contribute/report-a-bug/) +- [Report a docs issue](https://zensical.org/docs/community/contribute/report-a-docs-issue/) +- [Request a change](https://zensical.org/docs/community/contribute/request-a-change/) +- [Create a pull request](https://zensical.org/docs/community/contribute/pull-requests/) + +## Before creating an issue + +Before opening an issue, please take a moment to check whether a similar report or request already exists – a quick search can save everyone time. When you do open one, please fill out all fields in the issue template completely. Every field is there for a reason, and a thorough issue helps us understand and address your concern much faster. + +A few things to keep in mind: + +- **Issues are permanent.** Everything written on our issue tracker is public and stays there, so please be constructive and respectful at all times, in line with our [Code of Conduct]. +- **Use the right template.** Each template is designed for a specific purpose – pick the one that best fits your situation. +- **Keep it focused.** If your comment doesn't add to the current discussion, consider opening a new issue or using a reaction instead. +- **Questions belong in Discord.** The issue tracker is for bug reports, documentation issues, and change requests – not general questions. + +[Code of Conduct]: CODE_OF_CONDUCT.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..7b008c4a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,33 @@ +# Security policy + +## Reporting a vulnerability + +We take the security of Zensical seriously. If you believe you have found a security vulnerability in Zensical, we encourage you to report it to us responsibly. + +**Please do not report security vulnerabilities through public GitHub issues, pull requests, or discussions.** + +Instead, please send a report to hello@zensical.org with the following information: + +1. A description of the vulnerability and its potential impact. +2. The steps required to reproduce the issue. +3. Any relevant files, screenshots, or proof-of-concept code. +4. Your name and contact information, if you would like to be credited. + +## Our commitment + +We are committed to working with security researchers and our community to address vulnerabilities quickly and transparently. When you submit a report, you can expect the following: + +- **Acknowledgement** within 3 business days of your report. +- **Regular updates** on our progress as we investigate and address the issue. +- **Confidentiality** – we will not share your personal information without your permission, and we ask that you keep the vulnerability confidential until we have had the opportunity to address it. +- **Credit** – we are happy to acknowledge your contribution once the vulnerability has been resolved, if you would like. + +## Supported versions + +We release security fixes for the latest stable version of Zensical. We encourage all users to stay up to date with the latest release to ensure they benefit from all security patches. + +## Scope + +This policy applies to vulnerabilities in the Zensical codebase. If you discover a vulnerability in a third-party dependency, please report it to the maintainers of that project directly. + +We take dependency security seriously. We are deliberate in our selection of third-party dependencies, and we actively monitor and update them to ensure Zensical remains on the latest stable versions. If you believe a dependency we use poses a security risk, feel free to bring it to our attention at hello@zensical.org.