From c4238e916ddec3179fd6bb6a5c8653913726a32f Mon Sep 17 00:00:00 2001 From: Frank Denis Date: Thu, 12 Dec 2024 17:24:27 +0100 Subject: [PATCH] Expand the issue templates --- .github/ISSUE_TEMPLATE/bugs.md | 19 +++++++++++++------ .github/ISSUE_TEMPLATE/suggestions.md | 23 +++++++++++++++++++++++ 2 files changed, 36 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/suggestions.md diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md index e8ea67d8..ca1c6f5e 100644 --- a/.github/ISSUE_TEMPLATE/bugs.md +++ b/.github/ISSUE_TEMPLATE/bugs.md @@ -1,16 +1,23 @@ --- name: "\U0001F41E Issues" about: Bug reports -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- -THE ISSUE TRACKER IS DEDICATED TO KEEPING TRACK OF *BUGS*, +THE TRACKER IS DEDICATED TO KEEPING TRACK OF _BUGS_, preferably after they have been already discussed and confirmed to be reproducible. FOR ASSISTANCE, PLEASE CLOSE THIS FORM AND USE THE DISCUSSIONS SECTION INSTEAD: https://github.com/jedisct1/libsodium/discussions -Thank you! +Installation, configuration, usage guidance and issues in 3rd party packages are not bugs, but individual assistance requests. + +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 to reproduce it using the current `libsodium-stable` package, downloaded from [the official download site](https://download.libsodium.org/libsodium/releases/), and installed [as documented](https://doc.libsodium.org/installation). + +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 + +Thank you! 😊🙏 diff --git a/.github/ISSUE_TEMPLATE/suggestions.md b/.github/ISSUE_TEMPLATE/suggestions.md new file mode 100644 index 00000000..49e4f1eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestions.md @@ -0,0 +1,23 @@ +--- +name: "🙋🏽 Planned changes" +about: List of planned changes +title: "" +labels: "" +assignees: "" +--- + +Please do not post features requests directly. + +The starting point should be a discussion, after having checked the [roadmap](https://doc.libsodium.org/roadmap). + +Suggestions should be raised as an "Ideas" [discussion](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! 😊🙏 + +--- + +- [ ] Initially raised as discussion #...