From 7cfdf44893b74fb762757c37d14e441e98ab9663 Mon Sep 17 00:00:00 2001 From: Marcono1234 Date: Wed, 29 Sep 2021 01:35:55 +0200 Subject: [PATCH] Add GitHub issue templates (#1977) * Add GitHub issue templates * Adjust bug report issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 49 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 ++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++ README.md | 2 +- 4 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..483fd2effe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,49 @@ +--- +name: Bug report +about: Report a Gson bug. +title: '' +labels: bug +assignees: '' + +--- + +# Gson version + + + +# Java / Android version + + + +# Used tools + +- [ ] Maven; version: +- [ ] Gradle; version: +- [ ] ProGuard (attach the configuration file please); version: +- [ ] ... + +# Description + + + +## Expected behavior + + + +## Actual behavior + + + +# Reproduction steps + + + +1. ... +2. ... + +# Exception stack trace + + +``` + +``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..b798788d02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Usage question + url: https://stackoverflow.com/questions/tagged/gson + about: Ask usage questions on StackOverflow. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..87ed0f8ee3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Request a feature. ⚠️ Gson is in maintenance mode; large feature requests might be rejected. +title: '' +labels: feature-request +assignees: '' + +--- + +# Problem solved by the feature + + + +# Feature description + + + +# Alternatives / workarounds + + diff --git a/README.md b/README.md index 17acc950aa..a1dd0492ae 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Maven: * [Change log](https://github.com/google/gson/blob/master/CHANGELOG.md): Changes in the recent versions * [Design document](https://github.com/google/gson/blob/master/GsonDesignDocument.md): This document discusses issues we faced while designing Gson. It also includes a comparison of Gson with other Java libraries that can be used for Json conversion -Please use the 'gson' tag on StackOverflow or the [google-gson Google group](https://groups.google.com/group/google-gson) to discuss Gson or to post questions. +Please use the ['gson' tag on StackOverflow](https://stackoverflow.com/questions/tagged/gson) or the [google-gson Google group](https://groups.google.com/group/google-gson) to discuss Gson or to post questions. ### Related Content Created by Third Parties * [Gson Tutorial](https://www.studytrails.com/java/json/java-google-json-introduction/) by `StudyTrails`