From 53238aa796503e516fe20026372bdb6d7791aacd Mon Sep 17 00:00:00 2001 From: Lionel Bijaoui Date: Wed, 14 Mar 2018 17:57:53 +0100 Subject: [PATCH] Add issue and PR template --- ISSUE_TEMPLATE.md | 25 +++++++++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..f0fa73d2 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,25 @@ +**Note: for support questions, please use stackoverflow**. This repository's issues are reserved for feature requests and bug reports. + +* **I'm submitting a ...** + * [ ] bug report + * [ ] feature request + * [ ] support request => Please do not submit support request here, see note at the top of this template. + +- **Do you want to request a _feature_ or report a _bug_?** + +* **What is the current behavior?** + +- **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** via + https://jsfiddle.net/ or similar (you can use this template as a starting point: https://jsfiddle.net/icebob/0mg1v81e/). + +* **What is the expected behavior?** + +- **What is the motivation / use case for changing the behavior?** + +* **Please tell us about your environment:** + + * Version: [2.X.X | 3.0.0-beta.X] + * Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ] + * Language: [all | TypeScript X.X | ES6/7 | ES5 | Dart] + +- **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..56293c43 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +* **Please check if the PR fulfills these requirements** + +- [ ] The commit message follows our guidelines +- [ ] Tests for the changes have been added (for bug fixes / features) +- [ ] Docs have been added / updated (for bug fixes / features) + +* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + +- **What is the current behavior?** (You can also link to an open issue here) + +* **What is the new behavior (if this is a feature change)?** + +- **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) + +* **Other information**: