[gjs: 3/8] docs: Add issue templates
- From: Philip Chimento <pchimento src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gjs: 3/8] docs: Add issue templates
- Date: Thu, 8 Nov 2018 03:27:38 +0000 (UTC)
commit 87493ddde434fd924e91dd5c1d19198019eef205
Author: Philip Chimento <philip chimento gmail com>
Date: Wed Oct 24 22:07:30 2018 -0400
docs: Add issue templates
These should help contributors who report bugs do so more effectively.
The feature request template is a bit free-form, maybe more will be
needed in the future, but we don't get many feature requests opened right
now anyway.
See #17.
.gitlab/issue_templates/bug.md | 33 +++++++++++++++++++++++++++++++++
.gitlab/issue_templates/feature.md | 9 +++++++++
2 files changed, 42 insertions(+)
---
diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md
new file mode 100644
index 00000000..5f2c2f64
--- /dev/null
+++ b/.gitlab/issue_templates/bug.md
@@ -0,0 +1,33 @@
+# System information #
+What is your operating system and version? _(e.g. "Linux, Fedora 29" or "macOS 10.13")_
+
+What is your version of GJS? _(e.g. "1.54.1-fc29.1" or "commit 4ab70ef")_
+
+If the bug is related to GNOME Shell, what is your version of GNOME Shell? _(e.g. "3.30.1-2ubuntu1" or
"commit b405ed64")_
+
+# Bug information #
+## Steps to reproduce ##
+- Step by step, how can you make the problem appear?
+- List those steps here.
+- If the problem doesn't happen every time, note that as well.
+
+Even better, if the problem can be observed by executing a standalone JS
+file, paste that here instead of the steps.
+Use code blocks (```js) to format it.
+
+## Current behaviour ##
+What happened that made it evident there was a problem?
+Copy and paste the exact text of any error messages.
+Use code blocks (```) to format them.
+
+If the problem was with GNOME Shell, you may be able to find error
+messages in the system journal (`sudo journalctl -xb`).
+
+If GJS or GNOME Shell crashed, please include a stack trace.
+For information on how to get a stack trace,
+[read this wiki page](https://wiki.gnome.org/Community/GettingInTouch/Bugzilla/GettingTraces/Details).
+
+## Expected behaviour ##
+What did you expect to see instead?
+
+/label ~"1. Bug"
diff --git a/.gitlab/issue_templates/feature.md b/.gitlab/issue_templates/feature.md
new file mode 100644
index 00000000..ab0df879
--- /dev/null
+++ b/.gitlab/issue_templates/feature.md
@@ -0,0 +1,9 @@
+# Description #
+Explain why this feature should be added.
+Specific use cases are best.
+
+# Prior Art #
+List any comparable features in other JavaScript environments that you
+are aware of.
+
+/label ~"1. Feature"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]