From be789594372ed2fd90e3d18ed323dcd62f63563b Mon Sep 17 00:00:00 2001 From: Bartosz Polaczyk Date: Fri, 11 Feb 2022 18:05:49 +0100 Subject: [PATCH 1/3] Add Issue template --- issue_template.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 issue_template.md diff --git a/issue_template.md b/issue_template.md new file mode 100644 index 00000000..2336ea22 --- /dev/null +++ b/issue_template.md @@ -0,0 +1,71 @@ + + +**I'm submitting a ...** (check one with "x") + +[ ] Regression (a behavior that used to work and stopped working in a new release) +[ ] Bug report +[ ] Feature request +[ ] Documentation issue or request + +**My integration setup** + + +[ ] CocoaPods cocoapods-xcremotecache plugin +[ ] Automatic integration wusingith `xcprepare integrate ...` +[ ] Manual integration +[ ] Carthage + +**Expected/desired behavior** + + +**Minimal reproduction of the problem with instructions** + + +**What is the use case for changing the behavior?** + + +**Producer Logs** + + +
+
 [REPLACE THIS WITH YOUR INFORMATION] 
+
+ +**Consumer Logs** + + +
+
 [REPLACE THIS WITH YOUR INFORMATION] 
+
+ +**Pods/Carthage file** + + +
+
 [REPLACE THIS WITH YOUR INFORMATION] 
+
+ +**Environment** + + +* **XCRemoteCache:** X.Y.Z +* **cocoapods-xcremotecache:** X.Y.Z + +
+
 [REPLACE THIS WITH YOUR INFORMATION] 
+
+ +**Others** + \ No newline at end of file From 0436f6ae27291e88027ff38fc3aefba7ab8a84df Mon Sep 17 00:00:00 2001 From: Bartosz Polaczyk Date: Sun, 13 Feb 2022 21:55:56 +0100 Subject: [PATCH 2/3] Separate templates --- .../ISSUE_TEMPLATE/BUG_REPORT.md | 32 ++++++++----------- .github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md | 16 ++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 20 ++++++++++++ 3 files changed, 49 insertions(+), 19 deletions(-) rename issue_template.md => .github/ISSUE_TEMPLATE/BUG_REPORT.md (57%) create mode 100644 .github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md similarity index 57% rename from issue_template.md rename to .github/ISSUE_TEMPLATE/BUG_REPORT.md index 2336ea22..bba9c5b6 100644 --- a/issue_template.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -1,16 +1,14 @@ +--- +name: ⚠️ Bug Report +about: Something isn't working as expected + +--- + -**I'm submitting a ...** (check one with "x") - -[ ] Regression (a behavior that used to work and stopped working in a new release) -[ ] Bug report -[ ] Feature request -[ ] Documentation issue or request - **My integration setup** - [ ] CocoaPods cocoapods-xcremotecache plugin [ ] Automatic integration wusingith `xcprepare integrate ...` @@ -21,34 +19,30 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI **Minimal reproduction of the problem with instructions** - - -**What is the use case for changing the behavior?** - + **Producer Logs** - +
 [REPLACE THIS WITH YOUR INFORMATION] 
**Consumer Logs** - +
 [REPLACE THIS WITH YOUR INFORMATION] 
**Pods/Carthage file** - +
 [REPLACE THIS WITH YOUR INFORMATION] 
**Environment** - * **XCRemoteCache:** X.Y.Z * **cocoapods-xcremotecache:** X.Y.Z +* `xcprepare stats` (or `XCRC/xcprepare stats` for CocoaPods) +-->
 [REPLACE THIS WITH YOUR INFORMATION] 
diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md b/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md new file mode 100644 index 00000000..41b4189b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCUMENTATION_ISSUE.md @@ -0,0 +1,16 @@ +--- +name: 📕 Documentation Issue +about: Suggestion for a change in a documentation + +--- + + + +**A suggestion** + + +**Which file, section, line** + + diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 00000000..b764d1b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,20 @@ +--- +name: 🙏 Future Request +about: Suggestion for an improvement, either behaviour or implementation + +--- + + + + +**Expected/desired behavior** + + +**Relevant integration setup** + +[ ] CocoaPods cocoapods-xcremotecache plugin +[ ] Automatic integration wusingith `xcprepare integrate ...` +[ ] Manual integration +[ ] Carthage From d98d4cd0a37598a34b286f461eae3bdebd9f6f12 Mon Sep 17 00:00:00 2001 From: Bartosz Polaczyk Date: Mon, 14 Feb 2022 08:46:25 +0100 Subject: [PATCH 3/3] Apply suggestions from code review --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 2 +- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index bba9c5b6..c047a20d 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -11,7 +11,7 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI **My integration setup** [ ] CocoaPods cocoapods-xcremotecache plugin -[ ] Automatic integration wusingith `xcprepare integrate ...` +[ ] Automatic integration using `xcprepare integrate ...` [ ] Manual integration [ ] Carthage diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index b764d1b2..dfef01e5 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -15,6 +15,6 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI **Relevant integration setup** [ ] CocoaPods cocoapods-xcremotecache plugin -[ ] Automatic integration wusingith `xcprepare integrate ...` +[ ] Automatic integration using `xcprepare integrate ...` [ ] Manual integration [ ] Carthage