guidelines v1

2023-09-24 13:09:15 -03:00
parent fc1a1520e4
commit 74c8e40b18
2 changed files with 49 additions and 0 deletions
@@ -0,0 +1,38 @@
+---
+name: Issue Report
+about: Report an issue to help us improve
+title: '[ISSUE] '
+---
+
+**Article and Module Links**
+A link to the affected article and the affected module. The link to the module is the one in the "over on GitHub" standard phrase.
+
+**Describe the Issue**
+A clear and concise description of what the issue is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected Behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+- OS: [e.g. Windows]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Additional Context**
+Add any other context about the issue here.
+
+Note that, unfortunately, we can only help with issues that are specifically and directly related to the article - not with your own, custom application.
+
+StackOverflow is a great place to ask more general questions.
+
+That's primarily because we get a large number of questions and - while we do try to go through as much as everything and help wherever we can, we can't really get back to all of them.