new issue templates (#723)

2026-06-09 13:01:54 +00:00 · 2018-10-23 06:24:11 +02:00
parent c05557b900
commit 5cee6d7f14
8 changed files with 92 additions and 43 deletions
@@ -1,43 +0,0 @@
-## Note
-
- [ ] You may try to follow the update procedure described in the README and try again before opening this issue.
- [ ] Before asking for something, please check the [F.A.Q.](https://github.com/jfurrow/flood/wiki/F.A.Q.).
- [ ] Before opening a bug issue, please check the [Troubleshooting](https://github.com/jfurrow/flood/wiki/Troubleshooting) wiki section.
- [ ] If you want to contribute to the project please review the [contributing guidelines](https://github.com/jfurrow/flood/blob/master/.github/CONTRIBUTING.md).
- [ ] Keep in mind that Flood is a [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software#FLOSS) (Free, Libre and Open Source Software), so please try to provide a PR when opening a bug issue. Without contributions the project can't live and with your help fix and request will come faster.
- [ ] The project is accepting issues (bugs report), feature or enhancement requests, discussions and questions but **not personal support**.
-
-## Summary
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Expected Behavior
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-## Current Behavior
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug, -->
-<!--- or ideas how to implement the addition or change -->
-
-## Steps to Reproduce (for bugs)
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-  + Version (stable release) `git --no-pager tag`
-  + Commit ID (development release) `git --no-pager log -1`
-* Environment name and version (e.g. Chrome 39, node.js 5.4):
-* Operating System and version:
@@ -0,0 +1,44 @@
+---
+name: "🐞 Bug Report"
+about: "Report a general bug in flood"
+---
+Type: Bug Report
+
+- [ ] Try to follow the update procedure described in the README and try again before opening this issue.
+- [ ] Please check the [F.A.Q.](https://github.com/jfurrow/flood/wiki/F.A.Q.).
+- [ ] Please check the [Troubleshooting](https://github.com/jfurrow/flood/wiki/Troubleshooting) wiki section.
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+  + Version (stable release) `git --no-pager tag`
+  + Commit ID (development release) `git --no-pager log -1`
+* Environment name and version:
+  + Node.js version `node --version`
+  + npm version `npm --version`
+  + Web browser `name and version`
+* Operating System and version:
+
+## Summary
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- (Optional) Tell us what should happen -->
+
+## Current Behavior
+<!--- (Optional) Tell us what happens instead of the expected behavior -->
+
+## Possible Solution
+<!--- (Optional) suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- (Optional) What are you trying to accomplish? -->
@@ -0,0 +1,14 @@
+---
+name: "💡 Feature Request"
+about: "Suggest an idea for this project"
+---
+Type: Feature Request
+
+- [ ] If you want to contribute to the project please review the [contributing guidelines](https://github.com/jfurrow/flood/blob/master/.github/CONTRIBUTING.md).
+
+## Summary
+<!--- Provide a general summary of the feature in the Title above -->
+
+
+## Idea of implementation
+<!--- Suggest ideas how to implement the addition or change -->
@@ -0,0 +1,7 @@
+---
+name: "🔒 Security Vulnerability"
+about: "Report a security vulnerability in flood"
+---
+PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW.
+
+If you discover a security vulnerability within flood, please send an e-mail to jfurrow (me@johnfurrow.com) or noraj (cybersecurity@tutamail.com).
@@ -0,0 +1,8 @@
+---
+name: "📚 Documentation Issue"
+about: 'Report an issue or missing part in the documentation'
+---
+Type: Documentation Issue
+
+## Summary
+<!--- Provide a general summary of the issue in the Title above -->
@@ -0,0 +1,7 @@
+---
+name: "❓ Question"
+about: "Ask your questions here"
+---
+Type: Question
+
+## Question
@@ -0,0 +1,7 @@
+---
+name: "🎙️ Discussion"
+about: "Start a discussion here"
+---
+Type: Discussion
+
+## Discussion
@@ -0,0 +1,5 @@
+---
+name: "🆘 Support"
+about: "Ask for help on Discord"
+---
+If you need support, ask on Discord https://discord.gg/Z7yR5Uf