From 08b349a09b5bfada4e5f55911bd63a16a2172382 Mon Sep 17 00:00:00 2001 From: Frank Denis Date: Wed, 7 Jan 2026 23:22:39 +0100 Subject: [PATCH] Improve the issue templates --- .github/ISSUE_TEMPLATE/bugs.md | 33 ++++++++++++++++++--------- .github/ISSUE_TEMPLATE/suggestions.md | 15 +++++------- 2 files changed, 28 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index c95ff9bc..245deae6 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -1,23 +1,34 @@ --- -name: "\U0001F41E Issues" -about: Bug reports +name: "\U0001F41E Bug report" +about: Report a bug in libsodium title: "" labels: "" assignees: "" --- -THE TRACKER IS DEDICATED TO KEEPING TRACK OF _BUGS_, -preferably after they have been already discussed and confirmed to be reproducible. +Thanks for taking the time to report a bug! -FOR ASSISTANCE, PLEASE CLOSE THIS FORM AND USE THE DISCUSSIONS SECTION INSTEAD: -https://github.com/jedisct1/libsodium/discussions +This tracker is for confirmed, reproducible bugs. If you're looking for help with installation, configuration, usage, or issues with third-party packages, the [Discussions](https://github.com/jedisct1/libsodium/discussions) section is a better place to start. -Installation, configuration, usage guidance and issues in 3rd party packages are not bugs, but individual assistance requests. +### Before you file -If the bug is not trivial to reproduce on any platform, please include ALL the steps required to reliably duplicate it, on a vanilla, generic install of macOS, Windows, OpenBSD or Ubuntu Linux system, in their most current version. +- Try reproducing the issue with the current `libsodium-stable` package, installed as documented at https://doc.libsodium.org/installation +- If the bug isn't obvious, please describe all the steps needed to reproduce it on a fresh install of macOS, Windows, OpenBSD, or Ubuntu Linux -Try to reproduce it using the current `libsodium-stable` package, installed as documented in https://doc.libsodium.org/installation . +### Not sure if it's a bug? -If you don't have any clear understanding of the issue or can't enumerate the steps to reproduce it, open a discussion instead: https://github.com/jedisct1/libsodium/discussions +No worries! Feel free to [start a discussion](https://github.com/jedisct1/libsodium/discussions) first and we can figure it out together. -Thank you! 😊🙏 +--- + +### How do we replicate the issue? + +(Describe the steps to reproduce the bug) + +### Expected behavior + +(What did you expect to happen?) + +### Actual behavior + +(What actually happened?) diff --git a/.github/ISSUE_TEMPLATE/suggestions.md b/.github/ISSUE_TEMPLATE/suggestions.md index 48437635..d0cbd650 100644 --- a/.github/ISSUE_TEMPLATE/suggestions.md +++ b/.github/ISSUE_TEMPLATE/suggestions.md @@ -1,22 +1,19 @@ --- name: "🙋🏽 Planned changes" -about: List of planned changes +about: Track planned changes (maintainers only) title: "" labels: "" assignees: "" --- -Please do not post features requests directly. +Hey there! Got an idea for libsodium? -The starting point should be a discussion, after having checked the roadmap: https://doc.libsodium.org/roadmap +This template is for tracking work that's already been planned. For new feature suggestions, here's the best path forward: -Suggestions should be raised as an "Ideas" discussion: https://github.com/jedisct1/libsodium/discussions +1. Check the [roadmap](https://doc.libsodium.org/roadmap) to see if it's already on our radar +2. Start an "Ideas" thread in [Discussions](https://github.com/jedisct1/libsodium/discussions) -We can then determine if the discussion needs to be escalated into a "planned change" or not. - -This will help us ensure that the issue tracker properly reflects ongoing or needed work on the project. - -Thank you! 😊🙏 +From there, we can chat about it and decide together if it should become a planned change. This helps keep the issue tracker focused on active work. ---