Skip to content

Commit

Permalink
Expand the issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jedisct1 committed Dec 12, 2024
1 parent f9eeae6 commit c4238e9
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 6 deletions.
19 changes: 13 additions & 6 deletions .github/ISSUE_TEMPLATE/bugs.md
Original file line number Diff line number Diff line change
@@ -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! πŸ˜ŠπŸ™
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestions.md
Original file line number Diff line number Diff line change
@@ -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 #...

0 comments on commit c4238e9

Please sign in to comment.