From 0507d0a707002ef1d909bba22ac6e541768ffa9a Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:21:44 -0400 Subject: [PATCH 01/73] Create bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 116 ++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..2f4642ec0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,116 @@ +name: 🐞 Bug or Error Report +description: Report an anomaly or unexpected behavior with a sample from this repository. +labels: ['Needs: Triage :mag:', 'type:bug-suspected'] + +body: +- type: markdown + attributes: + value: | + - [x] Bug + + Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. + + - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). + - All bug reports are welcome - we want to fix them! + - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. + - We accept pull requests. If you know how to fix it - go ahead! + + Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* + + - type: input + validations: + required: true + attributes: + label: Which sample are you having troubles with? + description: > + Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? + + - type: input + validations: + required: true + attributes: + label: Authors + description: | + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. + + For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + + Don't @mention the repo maintainers, they already get notified. + +- type: dropdown + attributes: + label: Target SharePoint environment + options: + - SharePoint Online + - SharePoint Server 2019 (on-premise) + - SharePoint Server 2016 (on-premise) + validations: + required: true + +- type: dropdown + attributes: + label: Developer environment + options: + - Windows + - macOS + - Linux + +- type: checkboxes + attributes: + label: What browser(s) / client(s) have you tested + description: | + Select the browser(s)/clients this submission is relevant to. + + options: + - label: Internet Explorer + - label: Microsoft Edge + - label: Google Chrome + - label: FireFox + - label: Safari + - label: mobile (iOS/iPadOS) + - label: mobile (Android) + - label: not applicable + - label: other (enter in the "Additional environment details" area below) + +- type: textarea + attributes: + label: Additional environment details + description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field. + value: | + - browser version + - SPFx version + - Node.js version + - etc + +- type: markdown + attributes: + value: | + Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. + + **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it. + +- type: textarea + attributes: + label: Describe the observed behavior + validations: + required: true + +- type: textarea + attributes: + label: Steps to reproduce + description: How do you reproduce this? Please provide as much step-by-step detail as possible. + value: | + 1. + 2. + 3. + validations: + required: true + +- type: textarea + attributes: + label: Expected behavior + description: What did you expect to happen when the reproduce steps are followed? + validations: + required: true From a3051e0386073c680add012cb4370c56a9a31e9c Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:25:34 -0400 Subject: [PATCH 02/73] Create question.yml --- .github/question.yml | 93 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 .github/question.yml diff --git a/.github/question.yml b/.github/question.yml new file mode 100644 index 000000000..dbb8092af --- /dev/null +++ b/.github/question.yml @@ -0,0 +1,93 @@ +name: 🤔 Question or generic issue +description: Do you have a question? Or is it something else that doesn't fit one of the links below? Select this option! +labels: 'Needs: Triage' + +body: +- type: markdown + attributes: + value: | + This is for SharePoint development topics. If your submission is now about SharePoint development such as out-of-the-box capabilities, SharePoint configuration, please use refer to other support options listed on the [new issue chooser page](https://github.com/SharePoint/sp-dev-docs/issues/new/choose). Please provide as much information as possible so we can best address your submission. Thanks! + + - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/sp-dev-docs/wiki/How-to-Create-Good-Issues). + - Remember to include sufficient details and context. + - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. + + Please provide the following details about your environment. 🚨 *If this section is ignored, your submission will be flagged as **incomplete** & automatically closed.* + +- type: dropdown + attributes: + label: What type of issue is this? + options: + - Question + - Documentation issue / typo + - other + validations: + required: true + +- type: dropdown + attributes: + label: What SharePoint development model, framework, SDK or API is this about? + description: | + What tooling, frameworks, SDKs, or official libraries is this related to? Please include the version details in the *"Additional environment details"* field below. + + **This form is only for officially supported Microsoft products**. + + *If your question is about a third-party or another library/SDK/tooling that is not officially supported by Microsoft, please submit your issue to that project's relevant forum.* + + **NOTE**:đŸ’Ĩ If you select SharePoint Framework, you must include the following version numbers in the **Additional environment details** section below: 1ī¸âƒŖ SharePoint Framework & 2ī¸âƒŖ Node.js (`node -v`). + options: + - đŸ’Ĩ SharePoint Framework + - SharePoint Add-ins + - SharePoint CSOM + - SharePoint REST API + - Site designs & site scripts + - Declarative list formatting + - not applicable + - other (enter in the "Additional environment details" area below) + validations: + required: true + +- type: dropdown + attributes: + label: Target SharePoint environment + options: + - SharePoint Online + - SharePoint Server 2019 (on-premise) + - SharePoint Server 2016 (on-premise) + - other (enter in the "Additional environment details" area below) + validations: + required: true + +- type: checkboxes + attributes: + label: What browser(s) / client(s) have you tested + description: | + Select the browser(s)/clients this submission is relevant to. + + **NOTE**:đŸ’Ĩ If you select an item with this icon, you must include the version number of the selection in the **Additional environment details** section below. + options: + - label: đŸ’Ĩ Internet Explorer + - label: đŸ’Ĩ Microsoft Edge + - label: đŸ’Ĩ Google Chrome + - label: đŸ’Ĩ FireFox + - label: đŸ’Ĩ Safari + - label: mobile (iOS/iPadOS) + - label: mobile (Android) + - label: not applicable + - label: other (enter in the "Additional environment details" area below) + +- type: textarea + attributes: + label: Additional environment details + description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field. + value: | + - browser version + - SPFx version + - Node.js version + - etc + +- type: textarea + attributes: + label: Issue description + validations: + required: true From 08c1836018691f6464d8a18f1f1d69549561917b Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:26:18 -0400 Subject: [PATCH 03/73] Rename bug.md to bug.notmd --- .github/ISSUE_TEMPLATE/{bug.md => bug.notmd} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{bug.md => bug.notmd} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.notmd similarity index 100% rename from .github/ISSUE_TEMPLATE/bug.md rename to .github/ISSUE_TEMPLATE/bug.notmd From 68518ae38ab756ee8ccb376ae1dfd9df92bf3ed4 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:29:20 -0400 Subject: [PATCH 04/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 113 -------------------------- 1 file changed, 113 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2f4642ec0..0ae6c6f29 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,116 +1,3 @@ name: 🐞 Bug or Error Report description: Report an anomaly or unexpected behavior with a sample from this repository. labels: ['Needs: Triage :mag:', 'type:bug-suspected'] - -body: -- type: markdown - attributes: - value: | - - [x] Bug - - Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. - - - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). - - All bug reports are welcome - we want to fix them! - - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 - - Remember to include sufficient details and context. - - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. - - We accept pull requests. If you know how to fix it - go ahead! - - Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* - - - type: input - validations: - required: true - attributes: - label: Which sample are you having troubles with? - description: > - Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? - - - type: input - validations: - required: true - attributes: - label: Authors - description: | - Because of the way this repository is configured, samples authors do not get a notification when you create an issue. - - For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. - - Don't @mention the repo maintainers, they already get notified. - -- type: dropdown - attributes: - label: Target SharePoint environment - options: - - SharePoint Online - - SharePoint Server 2019 (on-premise) - - SharePoint Server 2016 (on-premise) - validations: - required: true - -- type: dropdown - attributes: - label: Developer environment - options: - - Windows - - macOS - - Linux - -- type: checkboxes - attributes: - label: What browser(s) / client(s) have you tested - description: | - Select the browser(s)/clients this submission is relevant to. - - options: - - label: Internet Explorer - - label: Microsoft Edge - - label: Google Chrome - - label: FireFox - - label: Safari - - label: mobile (iOS/iPadOS) - - label: mobile (Android) - - label: not applicable - - label: other (enter in the "Additional environment details" area below) - -- type: textarea - attributes: - label: Additional environment details - description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field. - value: | - - browser version - - SPFx version - - Node.js version - - etc - -- type: markdown - attributes: - value: | - Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. - - **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it. - -- type: textarea - attributes: - label: Describe the observed behavior - validations: - required: true - -- type: textarea - attributes: - label: Steps to reproduce - description: How do you reproduce this? Please provide as much step-by-step detail as possible. - value: | - 1. - 2. - 3. - validations: - required: true - -- type: textarea - attributes: - label: Expected behavior - description: What did you expect to happen when the reproduce steps are followed? - validations: - required: true From bc5e58dc2436ad953bf91bcd2f7ef17b8ac0f26d Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:29:36 -0400 Subject: [PATCH 05/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 0ae6c6f29..22098668f 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,3 +1,21 @@ name: 🐞 Bug or Error Report description: Report an anomaly or unexpected behavior with a sample from this repository. labels: ['Needs: Triage :mag:', 'type:bug-suspected'] + +body: +- type: markdown + attributes: + value: | + - [x] Bug + + Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. + + - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). + - All bug reports are welcome - we want to fix them! + - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. + - We accept pull requests. If you know how to fix it - go ahead! + + Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* + From 85791f3a84e11637f8319bfb8bb40866ca533c19 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:29:53 -0400 Subject: [PATCH 06/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 22098668f..d41de613a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -19,3 +19,10 @@ body: Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* +- type: input + validations: + required: true + attributes: + label: Which sample are you having troubles with? + description: > + Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? From d2c0a158115bd3808eea7dea1aa1926cb44f0537 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:33:01 -0400 Subject: [PATCH 07/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 79 +++++++++++++++++++-------- 1 file changed, 57 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index d41de613a..39aacfd99 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,28 +1,63 @@ -name: 🐞 Bug or Error Report -description: Report an anomaly or unexpected behavior with a sample from this repository. -labels: ['Needs: Triage :mag:', 'type:bug-suspected'] - +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: [bug, triage] +assignees: +- monalisa +- nat body: - type: markdown attributes: value: | - - [x] Bug - - Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. - - - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). - - All bug reports are welcome - we want to fix them! - - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 - - Remember to include sufficient details and context. - - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. - - We accept pull requests. If you know how to fix it - go ahead! - - Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* - + Thanks for taking the time to fill out this bug report! - type: input - validations: + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false +- type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true +- type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + validations: + required: true +- type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge +- type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell +- type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct required: true - attributes: - label: Which sample are you having troubles with? - description: > - Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? From 21a3e77cd502ae3a8e9faf6ed3f50b4f5e803aa7 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:33:27 -0400 Subject: [PATCH 08/73] Rename bug.notmd to bug.md --- .github/ISSUE_TEMPLATE/{bug.notmd => bug.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{bug.notmd => bug.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug.notmd b/.github/ISSUE_TEMPLATE/bug.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug.notmd rename to .github/ISSUE_TEMPLATE/bug.md From c273f80c0980689c751a7c613f4a0bf46f3cf93f Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:35:06 -0400 Subject: [PATCH 09/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 39aacfd99..e09cc6491 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,10 +1,8 @@ -name: Bug Report -description: File a bug report -title: "[Bug]: " -labels: [bug, triage] -assignees: -- monalisa -- nat +name: 🐞 Bug or Error Report +description: Report an anomaly or unexpected behavior with a sample from this repository. +title: "[Web Part Name]: [Issue Title]" +labels: ['Needs: Triage :mag:', 'type:bug-suspected'] + body: - type: markdown attributes: From 9067455d7afb2891b877df80474987a85f4defee Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:36:36 -0400 Subject: [PATCH 10/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index e09cc6491..68d18f23b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -4,6 +4,22 @@ title: "[Web Part Name]: [Issue Title]" labels: ['Needs: Triage :mag:', 'type:bug-suspected'] body: +- type: markdown + attributes: + value: | + - [x] Bug + + Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. + + - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). + - All bug reports are welcome - we want to fix them! + - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. + - We accept pull requests. If you know how to fix it - go ahead! + + Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* + - type: markdown attributes: value: | From 03f5ebbdaf83761d003edee209c50281b308d3f6 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:38:32 -0400 Subject: [PATCH 11/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 68d18f23b..fb9675676 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -20,16 +20,15 @@ body: Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* -- type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - type: input - id: contact + id: sample attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com + label: Sample + description: | + Which sample are you having troubles with? + + Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? + validations: required: false - type: textarea From 2ba4947bbcbbdb6ed6701061a145ec5f03c21d30 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:40:23 -0400 Subject: [PATCH 12/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index fb9675676..c5ea53676 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -22,6 +22,8 @@ body: - type: input id: sample + validations: + required: true attributes: label: Sample description: | @@ -29,8 +31,18 @@ body: Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? - validations: - required: false +- type: input + validations: + required: true + attributes: + label: Authors + description: | + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. + + For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + + Don't @mention the repo maintainers, they already get notified. + - type: textarea id: what-happened attributes: @@ -40,6 +52,7 @@ body: value: "A bug happened!" validations: required: true + - type: dropdown id: version attributes: From f90160ac870742c317db18d3e3f2803e84d13fb8 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:40:59 -0400 Subject: [PATCH 13/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index c5ea53676..448ebd312 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -32,11 +32,11 @@ body: Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? - type: input - validations: - required: true - attributes: - label: Authors - description: | + validations: + required: true + attributes: + label: Authors + description: | Because of the way this repository is configured, samples authors do not get a notification when you create an issue. For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. From f55686d47aa8586c75548fe0d5177a58f772da4a Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:41:54 -0400 Subject: [PATCH 14/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 448ebd312..26e564fe9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -35,13 +35,15 @@ body: validations: required: true attributes: - label: Authors + label: Author(s) description: | + Who wrote the sample? + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. - Don't @mention the repo maintainers, they already get notified. + **NOTE:** Don't @mention the repo maintainers, they already get notified. - type: textarea id: what-happened From cd9b11a1cc87610b1c5678bc9459266888ca95f3 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:44:54 -0400 Subject: [PATCH 15/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 26e564fe9..4101b63b6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -45,6 +45,25 @@ body: **NOTE:** Don't @mention the repo maintainers, they already get notified. +- type: dropdown + validations: + required: true + attributes: + label: Target SharePoint environment + options: + - SharePoint Online + - SharePoint Server 2019 (on-premise) + - SharePoint Server 2016 (on-premise) + +- type: dropdown + attributes: + label: Developer environment + options: + - Windows + - macOS + - Linux + + - type: textarea id: what-happened attributes: From 33abdbe11d6b3940391ea3ce5df42196a36e4e18 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:47:45 -0400 Subject: [PATCH 16/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 4101b63b6..2003c598d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -63,6 +63,29 @@ body: - macOS - Linux +- type: checkboxes + attributes: + label: Browsers + description: What browser(s) / client(s) have you tested + placeholder: Select the browser(s)/clients this submission is relevant to. + + options: + - label: Internet Explorer + - label: Microsoft Edge + - label: Google Chrome + - label: FireFox + - label: Safari + - label: mobile (iOS/iPadOS) + - label: mobile (Android) + - label: not applicable + - label: other (enter in the "Additional environment details" area below) + +- type: markdown + attributes: + value: | + Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. + + **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it. - type: textarea id: what-happened @@ -70,7 +93,6 @@ body: label: What happened? description: Also tell us, what did you expect to happen? placeholder: Tell us what you see! - value: "A bug happened!" validations: required: true From a4d8ab12e92db13c76766044dab16facc5bb6dfa Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:48:51 -0400 Subject: [PATCH 17/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2003c598d..c51fac6c3 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -65,9 +65,11 @@ body: - type: checkboxes attributes: - label: Browsers - description: What browser(s) / client(s) have you tested - placeholder: Select the browser(s)/clients this submission is relevant to. + label: Browsers + description: | + What browser(s) / client(s) have you tested + + Select the browser(s)/clients this submission is relevant to. options: - label: Internet Explorer From 026627088f0590fcd23457590a836dbe95eda4be Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:50:46 -0400 Subject: [PATCH 18/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index c51fac6c3..0ff7073e2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -108,27 +108,11 @@ body: - 1.0.3 (Edge) validations: required: true -- type: dropdown - id: browsers - attributes: - label: What browsers are you seeing the problem on? - multiple: true - options: - - Firefox - - Chrome - - Safari - - Microsoft Edge + - type: textarea id: logs attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell -- type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) - options: - - label: I agree to follow this project's Code of Conduct - required: true + From e48374717cf64e3c9f1976239b47b7c0eda38848 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:52:43 -0400 Subject: [PATCH 19/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 33 +++++++++++++++++---------- 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 0ff7073e2..88b45118b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -98,21 +98,30 @@ body: validations: required: true -- type: dropdown - id: version +- type: textarea attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.2 (Default) - - 1.0.3 (Edge) + label: Steps to reproduce + description: How do you reproduce this? Please provide as much step-by-step detail as possible. + value: | + 1. + 2. + 3. validations: required: true - type: textarea - id: logs attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell - + label: Expected behavior + description: What did you expect to happen when the reproduce steps are followed? + validations: + required: true + +- type: textarea + attributes: + label: Additional environment details + description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field. + value: | + - browser version + - SPFx version + - Node.js version + - etc From 04c6503af863ed6478efe0ca8e8174337fec5319 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 12:57:01 -0400 Subject: [PATCH 20/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 80 +++++++++++++++++---------- 1 file changed, 52 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 88b45118b..d91592ce4 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -45,6 +45,40 @@ body: **NOTE:** Don't @mention the repo maintainers, they already get notified. +- type: markdown + attributes: + value: | + Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. + + **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it. + +- type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + +- type: textarea + attributes: + label: Steps to reproduce + description: How do you reproduce this? Please provide as much step-by-step detail as possible. + value: | + 1. + 2. + 3. + validations: + required: true + +- type: textarea + attributes: + label: Expected behavior + description: What did you expect to happen when the reproduce steps are followed? + validations: + required: true + - type: dropdown validations: required: true @@ -82,40 +116,30 @@ body: - label: not applicable - label: other (enter in the "Additional environment details" area below) -- type: markdown - attributes: - value: | - Provide a clear & concise description of what the bug is. Please follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) which explains how to apply formatting, adding references & resources, screenshots, etc. - - **Do not attach ZIP files** of your code or compiled projects - instead, please publish your code to a public GitHub repo & post a link to it. - -- type: textarea - id: what-happened - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! +- type: input + id: spfx validations: required: true - -- type: textarea attributes: - label: Steps to reproduce - description: How do you reproduce this? Please provide as much step-by-step detail as possible. - value: | - 1. - 2. - 3. + label: SPFx version + description: | + Which version of SPFx are you using? + + TIP: To find out, run `npm ls -g --depth=0 @microsoft/generator-sharepoint` and provide the number that comes after `@microsoft/generator-sharepoint@` + +- type: input + id: Node validations: required: true - -- type: textarea attributes: - label: Expected behavior - description: What did you expect to happen when the reproduce steps are followed? - validations: - required: true - + label: Node.js version + description: | + Which version of Node.js are you using? + + TIP: To find out, run `node -v` + + + - type: textarea attributes: label: Additional environment details From f4d763fa2fc2788a989276cdc99dec8ca7818a16 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:00:03 -0400 Subject: [PATCH 21/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index d91592ce4..7b778f62e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -56,7 +56,7 @@ body: id: what-happened attributes: label: What happened? - description: Also tell us, what did you expect to happen? + description: Describe the observed behavior placeholder: Tell us what you see! validations: required: true @@ -76,6 +76,7 @@ body: attributes: label: Expected behavior description: What did you expect to happen when the reproduce steps are followed? + placeholder: Tell us what you expected to see! validations: required: true @@ -122,6 +123,7 @@ body: required: true attributes: label: SPFx version + placeholder: 1.11.0 description: | Which version of SPFx are you using? @@ -133,19 +135,8 @@ body: required: true attributes: label: Node.js version + placeholder: v10.23.1 description: | Which version of Node.js are you using? TIP: To find out, run `node -v` - - - -- type: textarea - attributes: - label: Additional environment details - description: Include as much detail about the environment you're targetting. This is required if "other (enter below)" is selected in the previous field. - value: | - - browser version - - SPFx version - - Node.js version - - etc From 2292a0629908674e7b08c4f8792b0c270cfdefcf Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:05:20 -0400 Subject: [PATCH 22/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7b778f62e..cac82b49a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -80,6 +80,13 @@ body: validations: required: true +- type: markdown + attributes: + value: | + When solving bugs, most time is spent going back and forth with the issue author asking for more information about their environment. + + Save yourself some time (and those who are trying to help you); provide us with your environment information so we can reproduce the issue. + - type: dropdown validations: required: true @@ -140,3 +147,8 @@ body: Which version of Node.js are you using? TIP: To find out, run `node -v` + +- type: textarea + attributes: + label: Additional environment details + description: Include as much detail about the environment you're targeting. This is required if "other (enter below)" is selected in the previous field. From a5f785aac343115f139102c081c371f3ea814f56 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:06:01 -0400 Subject: [PATCH 23/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index cac82b49a..16653c041 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -86,6 +86,8 @@ body: When solving bugs, most time is spent going back and forth with the issue author asking for more information about their environment. Save yourself some time (and those who are trying to help you); provide us with your environment information so we can reproduce the issue. + + We're not trying to be difficult here, we just want to help as quickly as possible. - type: dropdown validations: From df9b625c5224f0447d5a60d655080bc2a05cc74a Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:08:19 -0400 Subject: [PATCH 24/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 16653c041..de30952eb 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,5 @@ name: 🐞 Bug or Error Report description: Report an anomaly or unexpected behavior with a sample from this repository. -title: "[Web Part Name]: [Issue Title]" labels: ['Needs: Triage :mag:', 'type:bug-suspected'] body: @@ -32,6 +31,7 @@ body: Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? - type: input + id: authors validations: required: true attributes: @@ -62,6 +62,7 @@ body: required: true - type: textarea + id: steps attributes: label: Steps to reproduce description: How do you reproduce this? Please provide as much step-by-step detail as possible. @@ -73,6 +74,7 @@ body: required: true - type: textarea + id: expected attributes: label: Expected behavior description: What did you expect to happen when the reproduce steps are followed? @@ -90,6 +92,7 @@ body: We're not trying to be difficult here, we just want to help as quickly as possible. - type: dropdown + id: sharepoint-version validations: required: true attributes: @@ -100,6 +103,7 @@ body: - SharePoint Server 2016 (on-premise) - type: dropdown + id: environment-os attributes: label: Developer environment options: @@ -108,6 +112,7 @@ body: - Linux - type: checkboxes + id: browsers attributes: label: Browsers description: | @@ -151,6 +156,7 @@ body: TIP: To find out, run `node -v` - type: textarea + id: moar attributes: label: Additional environment details description: Include as much detail about the environment you're targeting. This is required if "other (enter below)" is selected in the previous field. From 22046f411e09e7035da7400a305bc46e2f426888 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:08:48 -0400 Subject: [PATCH 25/73] Delete bug.md --- .github/ISSUE_TEMPLATE/bug.md | 84 ----------------------------------- 1 file changed, 84 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index d84f22f46..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -name: "\U0001F41E Bug" -about: Report an anomaly or unexpected behavior with a sample from this repository. -title: '[Web Part Name]: [Issue Title]' -labels: type:bug -assignees: '' - ---- - -Thank you for reporting a bug! Use the sections below to submit a bug ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues - -- Bugs that do not follow the below template will automatically be closed -- All bug reports are welcome - we want to fix them! -- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 -- Include sufficient details and context. -- If you have multiple bugs please submit them separately so we can track resolution. -- Screenshots are always helpful (just paste any images right here in the bug report) -- We accept pull requests. If you know how to fix it - go ahead! - -DELETE EVERYTHING ABOVE AFTER READING - THANKS! - -## Sample -> Which sample are you having trouble with? -> -> Issues without a sample name will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - -## Authors - -> Because of the way this repository is configured, samples authors do not get a notification when you create an issue. *It makes it less likely for you to get your issue resolved or to get help*. For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "solution" section. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue. -> -> The author's name can be found in the sample's `README.md` file, under **Authors**. -> -> Issues without an author will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Expected or Desired Behavior - -> What should it do? -> -> Issues without an expected behavior will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Observed Behavior - -> What does it do? -> -> Issues without an observed behavior will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Steps to Reproduce - -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -> Issues without an steps to reproduce will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -# Environment Details (*Development & Target environment*) - -- **OS**: [e.g. Windows 10 | MacOS 10.15.x] -- **Target Environment**: [e.g. SharePoint Server 2016 | SharePoint Server 2019 | SharePoint Online] -- **Framework**: [e.g. .NET Framework v3.x | .NET Core v3.x | Node.js v6/v8/v10/v12] -- **Browser(s)**: [e.g. Chrome v79 | Safari v22 | FireFox v31 | IE v11 | Edge | Chromium Edge v79] -- **Tooling**: [e.g. VS Code | SPFx v1.10.0 | Visual Studio 2019] -- **Additional details**: *The more context you can provide, the easier it is (and therefore quicker) to help.* - -> Issues without environment details will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - -## Additional context From 26507de9b15802d58d9935003719bb52e053a911 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:09:17 -0400 Subject: [PATCH 26/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index de30952eb..4e53c2ca4 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,4 +1,4 @@ -name: 🐞 Bug or Error Report +name: 🐞 Bug or error report description: Report an anomaly or unexpected behavior with a sample from this repository. labels: ['Needs: Triage :mag:', 'type:bug-suspected'] From fa9c018ce1afd1be6cbecbb8570e1955dc8aa1c3 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:15:43 -0400 Subject: [PATCH 27/73] Create suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 63 +++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/suggestion.yml diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml new file mode 100644 index 000000000..cbfd2387b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -0,0 +1,63 @@ +name: "\U0001F4A1 Suggestion" +description: Suggest an enhancement to make one of our web part samples even better +labels: type:enhancement + +body: +- type: markdown + attributes: + value: | + + Thank you for your suggestion! Use the sections below to submit a suggestion ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. + + - Suggestions that do not follow the below template will automatically be closed + - All ideas are welcome - let's build something together! + - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple suggestions please submit them separately so we can track resolution. + - Screenshots are always helpful (just paste any images right here in the suggestion) + +- type: input + id: sample + validations: + required: true + attributes: + label: Sample + description: | + Which sample are you talking about + + Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? + +- type: input + id: authors + validations: + required: true + attributes: + label: Author(s) + description: | + Who wrote the sample? + + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. + + For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + + **NOTE:** Don't @mention the repo maintainers, they already get notified. + +- type: textarea + id: suggestion + attributes: + label: Suggestion + description: What would you like to see improved? + placeholder: The more details, the better + validations: + required: true + +- type: checkboxes + id: help + attributes: + label: Are you willing to help? + description: Would you be willing to help us make this improvement? + options: + - label: Yes + required: true + - label: No + required: true From bfa3ead84637af30ad820d349dcd38d353adbef2 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:17:09 -0400 Subject: [PATCH 28/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index cbfd2387b..58c883295 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -51,13 +51,14 @@ body: validations: required: true -- type: checkboxes +- type: dropdown id: help attributes: label: Are you willing to help? description: Would you be willing to help us make this improvement? options: - - label: Yes - required: true - - label: No - required: true + options: + - Yes + - No + validations: + required: true From a3e1ff4b6538fc5172b64559866187db906741d5 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:17:33 -0400 Subject: [PATCH 29/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 58c883295..27a829036 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -58,7 +58,7 @@ body: description: Would you be willing to help us make this improvement? options: options: - - Yes - - No + - "Yes" + - "No" validations: required: true From 66fe9ea073efcbe10ac87f157425add5a8aa3637 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:18:22 -0400 Subject: [PATCH 30/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 27a829036..ca345ec49 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -43,7 +43,6 @@ body: **NOTE:** Don't @mention the repo maintainers, they already get notified. - type: textarea - id: suggestion attributes: label: Suggestion description: What would you like to see improved? @@ -52,7 +51,6 @@ body: required: true - type: dropdown - id: help attributes: label: Are you willing to help? description: Would you be willing to help us make this improvement? From 53ceb3940ee3067aa07df338e0934cc20769a667 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:18:36 -0400 Subject: [PATCH 31/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index ca345ec49..ccbe67552 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -54,7 +54,6 @@ body: attributes: label: Are you willing to help? description: Would you be willing to help us make this improvement? - options: options: - "Yes" - "No" From 9cdf3e1015f307963ef98a559eed12345860ab2c Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:19:11 -0400 Subject: [PATCH 32/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index ccbe67552..70d263436 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -49,13 +49,3 @@ body: placeholder: The more details, the better validations: required: true - -- type: dropdown - attributes: - label: Are you willing to help? - description: Would you be willing to help us make this improvement? - options: - - "Yes" - - "No" - validations: - required: true From e76c1064269b0ae248a3883df225277c488dfb1b Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:19:29 -0400 Subject: [PATCH 33/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 70d263436..50af1a6c2 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -26,26 +26,3 @@ body: Which sample are you talking about Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? - -- type: input - id: authors - validations: - required: true - attributes: - label: Author(s) - description: | - Who wrote the sample? - - Because of the way this repository is configured, samples authors do not get a notification when you create an issue. - - For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. - - **NOTE:** Don't @mention the repo maintainers, they already get notified. - -- type: textarea - attributes: - label: Suggestion - description: What would you like to see improved? - placeholder: The more details, the better - validations: - required: true From 6245ff4d4d38d3abfaf365d6d44706a4234f897c Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:19:59 -0400 Subject: [PATCH 34/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 25 ------------------------- 1 file changed, 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 50af1a6c2..eade0214b 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,28 +1,3 @@ name: "\U0001F4A1 Suggestion" description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement - -body: -- type: markdown - attributes: - value: | - - Thank you for your suggestion! Use the sections below to submit a suggestion ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. - - - Suggestions that do not follow the below template will automatically be closed - - All ideas are welcome - let's build something together! - - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 - - Remember to include sufficient details and context. - - If you have multiple suggestions please submit them separately so we can track resolution. - - Screenshots are always helpful (just paste any images right here in the suggestion) - -- type: input - id: sample - validations: - required: true - attributes: - label: Sample - description: | - Which sample are you talking about - - Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? From 5aa2b8c67efc21ceb12f165cc2e05336913c685e Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:20:12 -0400 Subject: [PATCH 35/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index eade0214b..faf198c4a 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,3 +1,17 @@ name: "\U0001F4A1 Suggestion" description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement + +body: +- type: markdown + attributes: + value: | + + Thank you for your suggestion! Use the sections below to submit a suggestion ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues. + + - Suggestions that do not follow the below template will automatically be closed + - All ideas are welcome - let's build something together! + - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple suggestions please submit them separately so we can track resolution. + - Screenshots are always helpful (just paste any images right here in the suggestion) From 509b5775f3e47bff5db5cb70f8ab4b65e6d9ea48 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:20:29 -0400 Subject: [PATCH 36/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index faf198c4a..50af1a6c2 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -15,3 +15,14 @@ body: - Remember to include sufficient details and context. - If you have multiple suggestions please submit them separately so we can track resolution. - Screenshots are always helpful (just paste any images right here in the suggestion) + +- type: input + id: sample + validations: + required: true + attributes: + label: Sample + description: | + Which sample are you talking about + + Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? From e4413d8b4a06de70cd710f8eae39c2157cbcb7b4 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:20:52 -0400 Subject: [PATCH 37/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 50af1a6c2..4017245fe 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,4 +1,4 @@ -name: "\U0001F4A1 Suggestion" +name: Suggestion description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement From 1de9e59429ce93772ca7f10d3015604de35b94e0 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:21:34 -0400 Subject: [PATCH 38/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 36 ++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 4017245fe..9b6661e9a 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -25,4 +25,38 @@ body: description: | Which sample are you talking about - Use the sample name or URL. We don't want to be spend all this time diagnosing issues about the wrong sample, do we? + Use the sample name or URL. + +- type: input + id: authors + validations: + required: true + attributes: + label: Author(s) + description: | + Who wrote the sample? + + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. + + For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + + **NOTE:** Don't @mention the repo maintainers, they already get notified. + +- type: textarea + attributes: + label: Suggestion + description: What would you like to see improved? + placeholder: The more details, the better + validations: + required: true + + +- type: dropdown + attributes: + label: Are you willing to help? + description: Would you be willing to help us make this improvement? + options: + - "Yes" + - "No" + validations: + required: true From 832e95bb383fd030432f1c6846d4ce2af6652ffa Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:21:55 -0400 Subject: [PATCH 39/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 9b6661e9a..03329a0fb 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,4 +1,4 @@ -name: Suggestion +name: 💡 Suggestion description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement From 213773cd1a3b28c8ce060bf783b8e38e800aff85 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:22:25 -0400 Subject: [PATCH 40/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 03329a0fb..f2707b239 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,4 +1,4 @@ -name: 💡 Suggestion +name: Suggestion 💡 description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement From 54b12e715dbef54dab8d6e9ae35ac43dd4768602 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:22:55 -0400 Subject: [PATCH 41/73] Delete enhancement.md --- .github/ISSUE_TEMPLATE/enhancement.md | 43 --------------------------- 1 file changed, 43 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 992f82598..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: "\U0001F4A1 Suggestion" -about: Suggest an enhancement to make one of our web part samples even better -title: '[Web Part Name]: [Suggestion Title]' -labels: type:enhancement -assignees: '' - ---- - -Thank you for your suggestion! Use the sections below to submit a suggestion ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues - -- Suggestions that do not follow the below template will automatically be closed -- All ideas are welcome - let's build something together! -- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 -- Include sufficient details and context. -- If you have multiple suggestions please submit them separately so we can track resolution. -- Screenshots are always helpful (just paste any images right here in the suggestion) - -DELETE EVERYTHING ABOVE AFTER READING - THANKS! - -## Sample -> Which sample are you talking about -> -> Suggestions without a sample name will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Authors - -> Because of the way this repository is configured, samples authors do not get a notification when you create an issue. *It makes it less likely for you to get your issue resolved or to get help*. For the section above **@mention any author of the sample**. The authors' GitHub handle can be found on the main sample documentation page, under the "solution" section. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue. -> -> The authors can be found in the sample's `README.md` file, under **Authors** -> -> Suggestions without an author will be closed automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - -## Suggestion - -> The more details, the better -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ From 61883b68a0b18b18ee7f5e7928264ed83b8a2c10 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:23:09 -0400 Subject: [PATCH 42/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index f2707b239..03329a0fb 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,4 +1,4 @@ -name: Suggestion 💡 +name: 💡 Suggestion description: Suggest an enhancement to make one of our web part samples even better labels: type:enhancement From 6ee6e7c35edaf04db2e7800410d9c9ab071351f1 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:24:49 -0400 Subject: [PATCH 43/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index 03329a0fb..dcdb85d50 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -43,6 +43,7 @@ body: **NOTE:** Don't @mention the repo maintainers, they already get notified. - type: textarea + id: suggestion attributes: label: Suggestion description: What would you like to see improved? @@ -52,6 +53,7 @@ body: - type: dropdown + id: willing-to-help attributes: label: Are you willing to help? description: Would you be willing to help us make this improvement? From a4da5fd5ad060f1bdbebe4f73c3860d15675f263 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:26:00 -0400 Subject: [PATCH 44/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index dcdb85d50..b66461a85 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -1,6 +1,6 @@ name: 💡 Suggestion description: Suggest an enhancement to make one of our web part samples even better -labels: type:enhancement +labels: ['Needs: Triage :mag:', 'type:enhancement'] body: - type: markdown From 6349284eb9b2e01934e5a844e7f93f8122c25304 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:34:05 -0400 Subject: [PATCH 45/73] Update and rename question.md to question.yml --- .github/ISSUE_TEMPLATE/question.md | 44 ----------------------- .github/ISSUE_TEMPLATE/question.yml | 54 +++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 44 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 4bfbe3ba2..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: "❓ Question" -about: Ask a question about one of our web part samples -title: '' -labels: type:question -assignees: '' - ---- - -Thank you for asking a question! Use the sections below to submit a question ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues - -- Questions that do not follow the below template will automatically be closed -- All questions are welcome - let us know what's on your mind! -- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 -- Include sufficient details and context. -- If you have multiple questions please submit them separately so we can track resolution. -- Screenshots are always helpful (just paste any images right here in the question) -- If you're trying to start a conversation on a topic, consider using [Discussions](https://github.com/pnp/sp-dev-fx-webparts/discussions). We want to close every issue as quickly as possible, but discussions are intended for longer conversations. - -DELETE EVERYTHING ABOVE AFTER READING - THANKS! - -## Sample (which sample are you talking about) - -> Questions without a sample name will be rejected automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Authors - -> Because of the way this repository is configured, samples authors do not get a notification when you create an issue. *It makes it less likely for you to get your issue resolved or to get help*. For the section above **@mention any author of the sample**. The authors' GitHub handle can be found on the main sample documentation page, under the "solution" section. Use the `PREVIEW` tab at the top right to preview the rendering before submitting your issue. -> -> Questions without an author will be rejected automatically -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - -## Question - -> The more details, the better -> -> _(DELETE THIS PARAGRAPH AFTER READING)_ - - diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..0afe0079d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,54 @@ +name: ❓ Question +description: Ask a question about one of our web part samples +labels: ['Needs: Triage :mag:', 'type:question'] + +body: +- type: markdown + attributes: + value: | + + Thank you for asking a question! Use the sections below to submit a question ONLY if it's related to samples in this repo. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues + + - Questions that do not follow the below template will automatically be closed + - Don't use questions to diagnose issues with samples, that's what [bug reports](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml) are for! + - All questions are welcome - let us know what's on your mind! + - This repo is maintained by volunteers. Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple questions please submit them separately so we can track resolution. + - Screenshots are always helpful (just paste any images right here in the question) + - If you're trying to start a conversation on a topic, consider using [Discussions](https://github.com/pnp/sp-dev-fx-webparts/discussions). We want to close every issue as quickly as possible, but discussions are intended for longer conversations. + +- type: input + id: sample + validations: + required: true + attributes: + label: Sample + description: | + Which sample are you talking about + + Use the sample name or URL. + +- type: input + id: authors + validations: + required: true + attributes: + label: Author(s) + description: | + Who wrote the sample? + + Because of the way this repository is configured, samples authors do not get a notification when you create an issue. + + For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + + **NOTE:** Don't @mention the repo maintainers, they already get notified. + +- type: textarea + id: question + attributes: + label: Question + description: What would you like to know? + placeholder: The more details, the better + validations: + required: true From 601023e208081370ca5e8dbdf4f6c3c79043906b Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:41:06 -0400 Subject: [PATCH 46/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 4e53c2ca4..fc8096f1e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -15,7 +15,7 @@ body: - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 - Remember to include sufficient details and context. - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. - - We accept pull requests. If you know how to fix it - go ahead! + - We accept pull requests. If you know how to fix it - go ahead! If you know how to make it - go ahead! If you're unsure how to do a pull request, consider signing up for a free [Sharing is Caring First-Time Contributor](http://aka.ms/sharing-is-caring#pnp-sic-first-time-contributor) session. Please provide the following details about the issue you encountered. *Issues that do not provide the information requested in this form will be flagged as **incomplete** & automatically closed.* From bc88022f0928001574afe94653d5d3c74f544ba4 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:44:27 -0400 Subject: [PATCH 47/73] Update and rename samplerequest.md to samplerequest.yml --- .github/ISSUE_TEMPLATE/samplerequest.md | 24 --------------- .github/ISSUE_TEMPLATE/samplerequest.yml | 37 ++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 24 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/samplerequest.md create mode 100644 .github/ISSUE_TEMPLATE/samplerequest.yml diff --git a/.github/ISSUE_TEMPLATE/samplerequest.md b/.github/ISSUE_TEMPLATE/samplerequest.md deleted file mode 100644 index e2c2b7d7e..000000000 --- a/.github/ISSUE_TEMPLATE/samplerequest.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: "\U0001F9EA Sample request" -about: Request a new sample from the community -title: '' -labels: type:sample-request -assignees: '' - ---- - -Thank you for making a request! Use the sections below to submit a request ONLY for a new sample. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues - -- Requests that do not follow the below template will automatically be closed -- All requests are welcome - the more the merrier! -- This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 -- If you have multiple requests submit them separately so we can track resolution. -- Screenshots are always helpful (just paste any images right here in the request) -- We accept pull requests. If you know how to make it - go ahead! - -DELETE EVERYTHING ABOVE AFTER READING - THANKS! - -## Sample Description (what should it do) - - -## Are you Willing to Help? diff --git a/.github/ISSUE_TEMPLATE/samplerequest.yml b/.github/ISSUE_TEMPLATE/samplerequest.yml new file mode 100644 index 000000000..afafcb2a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/samplerequest.yml @@ -0,0 +1,37 @@ +name: "\U0001F9EA Sample request" +description: Request a new sample from the community +labels: ['Needs: Triage :mag:', 'type:sample-request', 'Help wanted đŸĒ§'] + +body: +- type: markdown + attributes: + value: | + + Thank you for making a request! Use the sections below to submit a request ONLY for a new sample. If you have an issue or question about the SharePoint Framework or its documentation, please submit it at https://aka.ms/spdev-issues + + - Requests that do not follow the below template will automatically be closed + - All requests are welcome - the more the merrier! + - This repo is maintained by volunteers. Please be courteous and patient. 🙂 + - Remember to include sufficient details and context. + - If you have multiple requests submit them separately so we can track resolution. + - We accept pull requests. If you know how to make it - go ahead! If you're unsure how to do a pull request, consider signing up for a free [Sharing is Caring First-Time Contributor](http://aka.ms/sharing-is-caring#pnp-sic-first-time-contributor) session. + +- type: textarea + id: description + attributes: + label: Sample description + description: What should the sample do? + placeholder: Tell us what you want, what you really, really want. + validations: + required: true + +- type: dropdown + id: willing-to-help + attributes: + label: Are you willing to help? + description: Would you be willing to help whoever decides to take this on? + options: + - "Yes" + - "No" + validations: + required: true From 0ffbc42dc777760c41edb305b8547d6ea64acb81 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:49:39 -0400 Subject: [PATCH 48/73] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index fc8096f1e..fb264971b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -12,7 +12,7 @@ body: - Follow our guidance on [How To Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues). - All bug reports are welcome - we want to fix them! - - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - This repo is maintained by volunteers. Please be courteous and patient. 🙂 - Remember to include sufficient details and context. - If you have multiple questions, suggestions, or bugs, please submit them in separate issues. - We accept pull requests. If you know how to fix it - go ahead! If you know how to make it - go ahead! If you're unsure how to do a pull request, consider signing up for a free [Sharing is Caring First-Time Contributor](http://aka.ms/sharing-is-caring#pnp-sic-first-time-contributor) session. @@ -43,6 +43,8 @@ body: For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + Issues without an @mention will be closed automatically, as authors won't get notified. + **NOTE:** Don't @mention the repo maintainers, they already get notified. - type: markdown From a8bbfce0a25f3b30b6e51419f568695d55b5fae3 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:50:11 -0400 Subject: [PATCH 49/73] Update suggestion.yml --- .github/ISSUE_TEMPLATE/suggestion.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml index b66461a85..bcda50fff 100644 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ b/.github/ISSUE_TEMPLATE/suggestion.yml @@ -11,7 +11,7 @@ body: - Suggestions that do not follow the below template will automatically be closed - All ideas are welcome - let's build something together! - - This repo is maintained by volunteers (not Microsoft). Please be courteous and patient. 🙂 + - This repo is maintained by volunteers. Please be courteous and patient. 🙂 - Remember to include sufficient details and context. - If you have multiple suggestions please submit them separately so we can track resolution. - Screenshots are always helpful (just paste any images right here in the suggestion) From a84e3459d9244d76a60faf2290069c5f106d01e7 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:51:15 -0400 Subject: [PATCH 50/73] Update question.yml --- .github/ISSUE_TEMPLATE/question.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 0afe0079d..9832adcce 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -42,6 +42,8 @@ body: For the section above **@mention any author of the sample**. Authors' GitHub handle can be found on the main sample documentation page, under the "Solution" section. + Questions without an @mention will automatically be closed, because authors won't get notified. + **NOTE:** Don't @mention the repo maintainers, they already get notified. - type: textarea From a8f6e54235fe4b494846cee65675679e3676417e Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:53:32 -0400 Subject: [PATCH 51/73] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..472b8fcd0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Contributor Covenant Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. From c1ff0dcd2678ad0bc3db79678e0e1964cb35a975 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:53:45 -0400 Subject: [PATCH 52/73] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..472b8fcd0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Contributor Covenant Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. From 6d9cb49b17c89b939c0ea79ba916dd2b2c21d07a Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 13:59:14 -0400 Subject: [PATCH 53/73] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 69427abc6..44ebc01d3 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ SharePoint client-side web parts are controls that appear inside a SharePoint pa Please use following logic on submitting your questions or issues to right location to ensure that they are noticed and addressed as soon as possible. * You have general question or challenge with SPFx - use [sp-dev-docs repository issue list](https://github.com/SharePoint/sp-dev-docs/issues). -* You have issue on specific web part or sample - use [issue list in this repository](https://github.com/SharePoint/sp-dev-fx-webparts/issues). +* You have issue on specific web part or sample - use [issue list in this repository](https://github.com/pnp/sp-dev-fx-webparts/issues). ## Additional resources From 1298197ffbc0a6ae224f867629d52f140a70af54 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:09:54 -0400 Subject: [PATCH 54/73] Create SUPPORT.md --- SUPPORT.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 SUPPORT.md diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 000000000..ccb122d7b --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,34 @@ +## Support Guidelines + +The SPFx web part samples repository is maintained by the [Patterns and Practices](https://aka.ms/m365pnp) team and the community, who all volunteer their time. + +We track bugs, user questions, suggestions and sample requests through [GitHub issues](https://github.com/pnp/sp-dev-fx-webparts/issues). + +Please help out as you can in response to issues and user questions. + +## Disclaimer + +**ALL SAMPLE CODE IN THIS REPOSITORY IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** + +## Have issues or questions? + +Please use following logic on submitting your questions or issues to right location to ensure that they are noticed and addressed as soon as possible. + +* You have general question or challenge with SPFx - use [sp-dev-docs repository issue list](https://github.com/SharePoint/sp-dev-docs/issues). +* You have issue on specific web part or sample - use [issue list in this repository](https://github.com/pnp/sp-dev-fx-webparts/issues). + +#### How to report a bug +We use GitHub to track issues. To report a bug, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose). Please include +all the information that might be relevant, including instructions for reproducing the bug. Make sure to read up on [how to create good issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues) to get your issue resolved faster. + +#### Where can I ask for help? +We use GitHub issues to support user questions. To ask a question, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the question template. + +#### How to submit changes +Please see our [Contributing Guidance](https://github.com/pnp/sp-dev-fx-webparts/blob/master/.github/CONTRIBUTING.md). + +#### How to request an enhancement +We use GitHub issues to support user suggestions. To request an enhanced, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the suggestion template. + +#### How to request an sample request +We use GitHub issues to support sample request. To request a new sample, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the sample request template. From f33993b9cd49ab70bd89483992d9f81528ed709b Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:11:11 -0400 Subject: [PATCH 55/73] Delete CONTRIBUTING.md --- .github/CONTRIBUTING.md | 197 ---------------------------------------- 1 file changed, 197 deletions(-) delete mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 5a2129a7a..000000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,197 +0,0 @@ -# Contribution Guidance - -If you'd like to contribute to this repository, please read the following guidelines. Contributors are more than welcome to share their learnings with others in this centralized location. - -## Code of Conduct - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - -Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient. - -## Question or Problem? - -Please do not open GitHub issues for general support questions as the GitHub list should be used for feature requests and bug reports. This way we can more easily track actual issues or bugs from the code and keep the general discussion separate from the actual code. - -If you have questions about how to use SharePoint Framework or any of the provided samples, please use the following locations. - -* [SharePoint Developer Space](http://aka.ms/SPPnP-Community) at http://techcommunity.microsoft.com -* [SharePoint Stack Exchange](http://sharepoint.stackexchange.com/) with 'spfx' tag - -## Typos, Issues, Bugs and contributions - -Whenever you are submitting any changes to the SharePoint repositories, please follow these recommendations. - -* Always fork the repository to your own account before making your modifications -* Do not combine multiple changes to one pull request. For example, submit any samples and documentation updates using separate PRs -* If your pull request shows merge conflicts, make sure to update your local master to be a mirror of what's in the main repo before making your modifications -* If you are submitting multiple samples, please create a specific PR for each of them -* If you are submitting typo or documentation fix, you can combine modifications to single PR where suitable - - -## Sample Naming and Structure Guidelines - -When you submit a new sample, please follow these guidelines: - -* Each sample must be placed in a folder under the `samples` folder -* Your sample folder must include the following content: - - Your solution's source code - - An `assets` folder, containing screenshots - - A `README.md` file -* You must only submit samples for which you have the rights to share. Make sure that you asked for permission from your employer and/or clients before committing the code to an open-source repository, because once you submit a pull request, the information is public and _cannot be removed_. - -### Sample Folder - -* When submitting a new sample solution, please name the sample solution folder accordingly -* Folder should start by identifying JS library used - like `react-`, `angular-`, `knockout-` -* If you are not using any specific JS library, please use `js-` as the prefix for your sample -* Do not use words such as `sample`, `webpart` or `wp` in the folder or sample name - these are samples for client-side web parts repository -* If your solution is demonstrating multiple technologies, please use functional terms as the name for the solution folder -* Do not use period/dot in the folder name of the provided sample - -### Source Code - -* For security reasons, we do not accept pull requests containing `.sppkg` files. We only accept source code files for applications. -* Make sure to place the root of your solution's source code in sample folder - -### README.md - -* You will need to have a `README.md` file for your contribution, which is based on [the provided template](../samples/README-template.md) under the `samples` folder. Please copy this template to your project and update it accordingly. Your `README.md` must be named exactly `README.md` -- with capital letters -- as this is the information we use to make your sample public. -* You will need to have a screenshot picture of your sample in action in the `README.md` file ("pics or it didn't happen"). The preview image must be located in the `assets` folder in the root of your sample folder. - * All screen shots must be located in the `assets` folder. Do not point to your own repository or any other external source -* The README template contains a specific tracking image at the end of the file with an `img` element pointing to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template`. This is a transparent image which is used to track how many visits each sample receives in GitHub. -* Update the image `src` attribute according with the repository name and folder information. For example, if your sample is named `react-todo` in the `samples` folder, you should update the `src` attribute to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo` - * Update the image `src` attribute according with the repository name and folder information. -* If you find an existing sample which is similar to yours, please extend the existing one rather than submitting a new similar sample - * When you update existing samples, please update also `README.md` file accordingly with information on provided changes and with your author details -* Make sure to document each function in the `README.md` -* If you include your social media information under **Authors** in the **Solution** section, we'll use this information to promote your contribution on social media, blog posts, and community calls. - * Try to use the following syntax: - ```md - folder name | Author Name ([@yourtwitterhandle](https://twitter.com/yourtwitterhandle)) - ``` -* If you include your company name after your name, we'll try to include your company name in blog posts and community calls. - * Try to use the following syntax: - ```md - folder name | Author Name ([@yourtwitterhandle](https://twitter.com/yourtwitterhandle)), Company Name - ``` -* For multiple authors, please provide one line per author -* If you prefer to not use social media or disclose your name, we'll still accept your sample, but we'll assume that you don't want us to promote your contribution on social media. - -### Assets - -* To help people make sense of your sample, make sure to always include at least one screenshot of your solution in action. People are more likely to click on a sample if they can preview it before installing it. -* Please provide a high-quality screenshot -* If possible, use a resolution of **1920x1080** -* You can add as many screen shots as you'd like to help users understand your sample without having to download it and install it. -* You can include animated images (such as `.gif` files), but you must provide at least one static `.png` file - * There is no need to include the steps where you find your web part and add it to a page. Just get to the good stuff! - -## Submitting Pull Requests - -> If you aren't familiar with how to contribute to open-source repositories using GitHub, or if you find the instructions on this page confusing, [sign up](https://forms.office.com/Pages/ResponsePage.aspx?id=KtIy2vgLW0SOgZbwvQuRaXDXyCl9DkBHq4A2OG7uLpdUREZVRDVYUUJLT1VNRDM4SjhGMlpUNzBORy4u) for one of our [Sharing is Caring](https://pnp.github.io/sharing-is-caring/#pnp-sic-events) events. It's completely free, and we'll guide you through the process. - - -Here's a high-level process for submitting new samples or updates to existing ones. - -1. Sign the Contributor License Agreement (see below) -2. Fork this repository [pnp/sp-dev-fx-webparts](https://github.com/pnp/sp-dev-fx-webparts) to your GitHub account -3. Create a new branch from the `master` branch for your fork for the contribution -4. Include your changes to your branch -5. Commit your changes using descriptive commit message * These are used to track changes on the repositories for monthly communications -6. Create a pull request in your own fork and target the `master` branch -7. Fill up the provided PR template with the requested details - -Before you submit your pull request consider the following guidelines: - -* Search [GitHub](https://github.com/pnp/sp-dev-fx-webparts/pulls) for an open or closed Pull Request - which relates to your submission. You don't want to duplicate effort. -* Make sure you have a link in your local cloned fork to the [pnp/sp-dev-fx-webparts](https://github.com/pnp/sp-dev-fx-webparts): - - ```shell - # check if you have a remote pointing to the Microsoft repo: - git remote -v - - # if you see a pair of remotes (fetch & pull) that point to https://github.com/pnp/sp-dev-fx-webparts, you're ok... otherwise you need to add one - - # add a new remote named "upstream" and point to the Microsoft repo - git remote add upstream https://github.com/pnp/sp-dev-fx-webparts.git - ``` - -* Make your changes in a new git branch: - - ```shell - git checkout -b react-taxonomypicker master - ``` - -* Ensure your fork is updated and not behind the upstream **sp-dev-fx-webparts** repo. Refer to these resources for more information on syncing your repo: - * [GitHub Help: Syncing a Fork](https://help.github.com/articles/syncing-a-fork/) - * [Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo](http://www.andrewconnell.com/blog/keep-your-forked-git-repo-updated-with-changes-from-the-original-upstream-repo) - * For a quick cheat sheet: - - ```shell - # assuming you are in the folder of your locally cloned fork.... - git checkout master - - # assuming you have a remote named `upstream` pointing official **sp-dev-fx-webparts** repo - git fetch upstream - - # update your local master to be a mirror of what's in the main repo - git pull --rebase upstream master - - # switch to your branch where you are working, say "react-taxonomypicker" - git checkout react-taxonomypicker - - # update your branch to update it's fork point to the current tip of master & put your changes on top of it - git rebase master - ``` - -* Push your branch to GitHub: - - ```shell - git push origin react-taxonomypicker - ``` - -## Merging your Existing GitHub Projects with this Repository - -If the sample you wish to contribute is stored in your own GitHub repository, you can use the following steps to merge it with this repository: - -* Fork the `sp-dev-fx-webparts` repository from GitHub -* Create a local git repository - - ```shell - md sp-dev-fx-webparts - cd sp-dev-fx-webparts - git init - ``` - -* Pull your forked copy of `sp-dev-fx-webparts` into your local repository - - ```shell - git remote add origin https://github.com/yourgitaccount/sp-dev-fx-webparts.git - git pull origin master - ``` - -* Pull your other project from GitHub into the `samples` folder of your local copy of `sp-dev-fx-webparts` - - ```shell - git subtree add --prefix=samples/projectname https://github.com/yourgitaccount/projectname.git master - ``` - -* Push the changes up to your forked repository - - ```shell - git push origin master - ``` - -## Signing the CLA - -Before we can accept your pull requests you will be asked to sign electronically Contributor License Agreement (CLA), which is a pre-requisite for any contributions all PnP repositories. This will be one-time process, so for any future contributions you will not be asked to re-sign anything. After the CLA has been signed, our PnP core team members will have a look at your submission for a final verification of the submission. Please do not delete your development branch until the submission has been closed. - -You can find Microsoft CLA from the following address - https://cla.microsoft.com. - -Thank you for your contribution. - -> Sharing is caring. - - From af6d5adce5080da2eac3fd7981a1aa5f1cf8f290 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:11:53 -0400 Subject: [PATCH 56/73] Create CONTRIBUTING.md --- CONTRIBUTING.md | 197 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 197 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..1543f7224 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,197 @@ +# Contribution Guidance + +If you'd like to contribute to this repository, please read the following guidelines. Contributors are more than welcome to share their learnings with others in this centralized location. + +## Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient. + +## Question or Problem? + +Please do not open GitHub issues for general support questions as the GitHub list should be used for feature requests and bug reports. This way we can more easily track actual issues or bugs from the code and keep the general discussion separate from the actual code. + +If you have questions about how to use SharePoint Framework or any of the provided samples, please use the following locations. + +* [SharePoint Developer Space](http://aka.ms/SPPnP-Community) at http://techcommunity.microsoft.com +* [SharePoint Stack Exchange](http://sharepoint.stackexchange.com/) with 'spfx' tag + +## Typos, Issues, Bugs and contributions + +Whenever you are submitting any changes to the SharePoint repositories, please follow these recommendations. + +* Always fork the repository to your own account before making your modifications +* Do not combine multiple changes to one pull request. For example, submit any samples and documentation updates using separate PRs +* If your pull request shows merge conflicts, make sure to update your local master to be a mirror of what's in the main repo before making your modifications +* If you are submitting multiple samples, please create a specific PR for each of them +* If you are submitting typo or documentation fix, you can combine modifications to single PR where suitable + + +## Sample Naming and Structure Guidelines + +When you submit a new sample, please follow these guidelines: + +* Each sample must be placed in a folder under the `samples` folder +* Your sample folder must include the following content: + - Your solution's source code + - An `assets` folder, containing screenshots + - A `README.md` file +* You must only submit samples for which you have the rights to share. Make sure that you asked for permission from your employer and/or clients before committing the code to an open-source repository, because once you submit a pull request, the information is public and _cannot be removed_. + +### Sample Folder + +* When submitting a new sample solution, please name the sample solution folder accordingly +* Folder should start by identifying JS library used - like `react-`, `angular-`, `knockout-` +* If you are not using any specific JS library, please use `js-` as the prefix for your sample +* Do not use words such as `sample`, `webpart` or `wp` in the folder or sample name - these are samples for client-side web parts repository +* If your solution is demonstrating multiple technologies, please use functional terms as the name for the solution folder +* Do not use period/dot in the folder name of the provided sample + +### Source Code + +* For security reasons, we do not accept pull requests containing `.sppkg` files. We only accept source code files for applications. +* Make sure to place the root of your solution's source code in sample folder + +### README.md + +* You will need to have a `README.md` file for your contribution, which is based on [the provided template](../samples/README-template.md) under the `samples` folder. Please copy this template to your project and update it accordingly. Your `README.md` must be named exactly `README.md` -- with capital letters -- as this is the information we use to make your sample public. +* You will need to have a screenshot picture of your sample in action in the `README.md` file ("pics or it didn't happen"). The preview image must be located in the `assets` folder in the root of your sample folder. + * All screen shots must be located in the `assets` folder. Do not point to your own repository or any other external source +* The README template contains a specific tracking image at the end of the file with an `img` element pointing to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/readme-template`. This is a transparent image which is used to track how many visits each sample receives in GitHub. +* Update the image `src` attribute according with the repository name and folder information. For example, if your sample is named `react-todo` in the `samples` folder, you should update the `src` attribute to `https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-todo` + * Update the image `src` attribute according with the repository name and folder information. +* If you find an existing sample which is similar to yours, please extend the existing one rather than submitting a new similar sample + * When you update existing samples, please update also `README.md` file accordingly with information on provided changes and with your author details +* Make sure to document each function in the `README.md` +* If you include your social media information under **Authors** in the **Solution** section, we'll use this information to promote your contribution on social media, blog posts, and community calls. + * Try to use the following syntax: + ```md + folder name | Author Name ([@yourtwitterhandle](https://twitter.com/yourtwitterhandle)) + ``` +* If you include your company name after your name, we'll try to include your company name in blog posts and community calls. + * Try to use the following syntax: + ```md + folder name | Author Name ([@yourtwitterhandle](https://twitter.com/yourtwitterhandle)), Company Name + ``` +* For multiple authors, please provide one line per author +* If you prefer to not use social media or disclose your name, we'll still accept your sample, but we'll assume that you don't want us to promote your contribution on social media. + +### Assets + +* To help people make sense of your sample, make sure to always include at least one screenshot of your solution in action. People are more likely to click on a sample if they can preview it before installing it. +* Please provide a high-quality screenshot +* If possible, use a resolution of **1920x1080** +* You can add as many screen shots as you'd like to help users understand your sample without having to download it and install it. +* You can include animated images (such as `.gif` files), but you must provide at least one static `.png` file + * There is no need to include the steps where you find your web part and add it to a page. Just get to the good stuff! + +## Submitting Pull Requests + +> If you aren't familiar with how to contribute to open-source repositories using GitHub, or if you find the instructions on this page confusing, [sign up](https://forms.office.com/Pages/ResponsePage.aspx?id=KtIy2vgLW0SOgZbwvQuRaXDXyCl9DkBHq4A2OG7uLpdUREZVRDVYUUJLT1VNRDM4SjhGMlpUNzBORy4u) for one of our [Sharing is Caring](https://pnp.github.io/sharing-is-caring/#pnp-sic-events) events. It's completely free, and we'll guide you through the process. + + +Here's a high-level process for submitting new samples or updates to existing ones. + +1. Sign the Contributor License Agreement (see below) +2. Fork this repository [pnp/sp-dev-fx-webparts](https://github.com/pnp/sp-dev-fx-webparts) to your GitHub account +3. Create a new branch from the `master` branch for your fork for the contribution +4. Include your changes to your branch +5. Commit your changes using descriptive commit message * These are used to track changes on the repositories for monthly communications +6. Create a pull request in your own fork and target the `master` branch +7. Fill up the provided PR template with the requested details + +Before you submit your pull request consider the following guidelines: + +* Search [GitHub](https://github.com/pnp/sp-dev-fx-webparts/pulls) for an open or closed Pull Request + which relates to your submission. You don't want to duplicate effort. +* Make sure you have a link in your local cloned fork to the [pnp/sp-dev-fx-webparts](https://github.com/pnp/sp-dev-fx-webparts): + + ```shell + # check if you have a remote pointing to the Microsoft repo: + git remote -v + + # if you see a pair of remotes (fetch & pull) that point to https://github.com/pnp/sp-dev-fx-webparts, you're ok... otherwise you need to add one + + # add a new remote named "upstream" and point to the Microsoft repo + git remote add upstream https://github.com/pnp/sp-dev-fx-webparts.git + ``` + +* Make your changes in a new git branch: + + ```shell + git checkout -b react-taxonomypicker master + ``` + +* Ensure your fork is updated and not behind the upstream **sp-dev-fx-webparts** repo. Refer to these resources for more information on syncing your repo: + * [GitHub Help: Syncing a Fork](https://help.github.com/articles/syncing-a-fork/) + * [Keep Your Forked Git Repo Updated with Changes from the Original Upstream Repo](http://www.andrewconnell.com/blog/keep-your-forked-git-repo-updated-with-changes-from-the-original-upstream-repo) + * For a quick cheat sheet: + + ```shell + # assuming you are in the folder of your locally cloned fork.... + git checkout master + + # assuming you have a remote named `upstream` pointing official **sp-dev-fx-webparts** repo + git fetch upstream + + # update your local master to be a mirror of what's in the main repo + git pull --rebase upstream master + + # switch to your branch where you are working, say "react-taxonomypicker" + git checkout react-taxonomypicker + + # update your branch to update it's fork point to the current tip of master & put your changes on top of it + git rebase master + ``` + +* Push your branch to GitHub: + + ```shell + git push origin react-taxonomypicker + ``` + +## Merging your Existing GitHub Projects with this Repository + +If the sample you wish to contribute is stored in your own GitHub repository, you can use the following steps to merge it with this repository: + +* Fork the `sp-dev-fx-webparts` repository from GitHub +* Create a local git repository + + ```shell + md sp-dev-fx-webparts + cd sp-dev-fx-webparts + git init + ``` + +* Pull your forked copy of `sp-dev-fx-webparts` into your local repository + + ```shell + git remote add origin https://github.com/yourgitaccount/sp-dev-fx-webparts.git + git pull origin master + ``` + +* Pull your other project from GitHub into the `samples` folder of your local copy of `sp-dev-fx-webparts` + + ```shell + git subtree add --prefix=samples/projectname https://github.com/yourgitaccount/projectname.git master + ``` + +* Push the changes up to your forked repository + + ```shell + git push origin master + ``` + +## Signing the CLA + +Before we can accept your pull requests you will be asked to sign electronically Contributor License Agreement (CLA), which is a pre-requisite for any contributions all PnP repositories. This will be one-time process, so for any future contributions you will not be asked to re-sign anything. After the CLA has been signed, our PnP core team members will have a look at your submission for a final verification of the submission. Please do not delete your development branch until the submission has been closed. + +You can find Microsoft CLA from the following address - https://cla.microsoft.com. + +Thank you for your contribution. + +> Sharing is caring. + + From 3a9b72be04e8ae53ea6f4e6046b819c2aa691c4b Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:13:13 -0400 Subject: [PATCH 57/73] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 472b8fcd0..e7aa4c5e5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -3,3 +3,5 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient. From a2dbf69df51b3527eca6115854d5299e3fb663ce Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:13:47 -0400 Subject: [PATCH 58/73] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 44ebc01d3..3e1e317ba 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ This repository's contributors are all community members who volunteered their t These samples are direct from the feature teams, SharePoint PnP core team (http://aka.ms/m365pnp) or shared by the community. We welcome your input on issues and suggestions for new samples. We do also welcome community contributions around the client-side web parts. If you have any questions, just let us know. -Please have a look on our [Contribution Guidance](./.github/CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible. +Please have a look on our [Contribution Guidance](./CONTRIBUTING.md) before submitting your pull requests, so that we can get your contribution processed as fast as possible. ## Code of Conduct This repository has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. From c38007cc0738e3a72705c287b609bf53d9212201 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:14:25 -0400 Subject: [PATCH 59/73] Update CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e7aa4c5e5..4f3aca2c0 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -5,3 +5,5 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient. + + From 6ea4b5415026c29cb815819c437ba40dbe8b8ead Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:14:47 -0400 Subject: [PATCH 60/73] Update SUPPORT.md --- SUPPORT.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SUPPORT.md b/SUPPORT.md index ccb122d7b..3fe56742d 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -32,3 +32,5 @@ We use GitHub issues to support user suggestions. To request an enhanced, [open #### How to request an sample request We use GitHub issues to support sample request. To request a new sample, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the sample request template. + + From 43afd31d928e6510b432e9fab836263006479e64 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:28:58 -0400 Subject: [PATCH 61/73] Create SECURITY.md --- SECURITY.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..180ed3f43 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,18 @@ +# Security Policy + +## Disclaimer + +**ALL SAMPLE CODE IN THIS REPOSITORY IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** + +--- + +## Supported Versions + +All code samples in this repository are intended for education purposes only and should not be used directly in production without a proper security review from your organization's security team. + + +## Reporting a Vulnerability + +To report a vulnerability, please [create an issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and tag the issue as `vulnerability-suspected`. + +Upon receipt of the issue, we will flag the sample as having a suspected vulnerability and request the support from the community to identify and resolve, if possible, the issue. From d9cab7810fbea7a6f570b4a9603bc4ac7486a7cb Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:29:47 -0400 Subject: [PATCH 62/73] Create codeql-analysis.yml --- .github/workflows/codeql-analysis.yml | 67 +++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 .github/workflows/codeql-analysis.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 000000000..ee274a644 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,67 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '33 2 * * 0' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'javascript' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 From 7f06010b45a644e37fb9ce0ee58fc5054b11d997 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:31:30 -0400 Subject: [PATCH 63/73] Update greetings.yml --- .github/workflows/greetings.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index c7860abd3..3e18a8eef 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -9,7 +9,7 @@ jobs: - uses: actions/first-interaction@v1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} - pr-message: > + pr-message: | Thank you for submitting your first pull request! We love celebrating the awesome work our contributors do on social media and community calls; Make sure that you update your GitHub user profile with your Twitter user name, your company name, and your picture. From 6077d3a756dd81388359ff7e4f567fd9fccc2b04 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:33:51 -0400 Subject: [PATCH 64/73] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4d4c0391e..3bd1d344a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -> By submitting this pull request, you agree to the [contribution guidelines](CONTRIBUTING.md) +> By submitting this pull request, you agree to the [contribution guidelines](https://github.com/pnp/sp-dev-fx-webparts/CONTRIBUTING.md) > If you aren't familiar with how to contribute to open-source repositories using GitHub, or if you find the instructions on this page confusing, [sign up](https://forms.office.com/Pages/ResponsePage.aspx?id=KtIy2vgLW0SOgZbwvQuRaXDXyCl9DkBHq4A2OG7uLpdUREZVRDVYUUJLT1VNRDM4SjhGMlpUNzBORy4u) for one of our [Sharing is Caring](https://pnp.github.io/sharing-is-caring/#pnp-sic-events) events. It's completely free, and we'll guide you through the process. From 8c3cad609ce9fd43bf4ac531afb8f9cecad63221 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:34:51 -0400 Subject: [PATCH 65/73] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3bd1d344a..6c1855d47 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -> By submitting this pull request, you agree to the [contribution guidelines](https://github.com/pnp/sp-dev-fx-webparts/CONTRIBUTING.md) +> By submitting this pull request, you agree to the [contribution guidelines](https://github.com/pnp/sp-dev-fx-webparts/blob/master/CONTRIBUTING.md) > If you aren't familiar with how to contribute to open-source repositories using GitHub, or if you find the instructions on this page confusing, [sign up](https://forms.office.com/Pages/ResponsePage.aspx?id=KtIy2vgLW0SOgZbwvQuRaXDXyCl9DkBHq4A2OG7uLpdUREZVRDVYUUJLT1VNRDM4SjhGMlpUNzBORy4u) for one of our [Sharing is Caring](https://pnp.github.io/sharing-is-caring/#pnp-sic-events) events. It's completely free, and we'll guide you through the process. From c916705b61ef35071466bec7262d314ce02d3b09 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:35:47 -0400 Subject: [PATCH 66/73] Update SUPPORT.md --- SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SUPPORT.md b/SUPPORT.md index 3fe56742d..77b52641f 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -25,7 +25,7 @@ all the information that might be relevant, including instructions for reproduci We use GitHub issues to support user questions. To ask a question, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the question template. #### How to submit changes -Please see our [Contributing Guidance](https://github.com/pnp/sp-dev-fx-webparts/blob/master/.github/CONTRIBUTING.md). +Please see our [Contributing Guidance](https://github.com/pnp/sp-dev-fx-webparts/blob/master/CONTRIBUTING.md). #### How to request an enhancement We use GitHub issues to support user suggestions. To request an enhanced, [open a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new/choose) and select the suggestion template. From 4345caf31706fbb6a2c528e8d60954e96879b27a Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:39:12 -0400 Subject: [PATCH 67/73] Create ossar-analysis.yml --- .github/workflows/ossar-analysis.yml | 44 ++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/ossar-analysis.yml diff --git a/.github/workflows/ossar-analysis.yml b/.github/workflows/ossar-analysis.yml new file mode 100644 index 000000000..c7cc7cd62 --- /dev/null +++ b/.github/workflows/ossar-analysis.yml @@ -0,0 +1,44 @@ +# This workflow integrates a collection of open source static analysis tools +# with GitHub code scanning. For documentation, or to provide feedback, visit +# https://github.com/github/ossar-action +name: OSSAR + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '36 20 * * 2' + +jobs: + OSSAR-Scan: + # OSSAR runs on windows-latest. + # ubuntu-latest and macos-latest support coming soon + runs-on: windows-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Ensure a compatible version of dotnet is installed. + # The [Microsoft Security Code Analysis CLI](https://aka.ms/mscadocs) is built with dotnet v3.1.201. + # A version greater than or equal to v3.1.201 of dotnet must be installed on the agent in order to run this action. + # GitHub hosted runners already have a compatible version of dotnet installed and this step may be skipped. + # For self-hosted runners, ensure dotnet version 3.1.201 or later is installed by including this action: + # - name: Install .NET + # uses: actions/setup-dotnet@v1 + # with: + # dotnet-version: '3.1.x' + + # Run open source static analysis tools + - name: Run OSSAR + uses: github/ossar-action@v1 + id: ossar + + # Upload results to the Security tab + - name: Upload OSSAR results + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: ${{ steps.ossar.outputs.sarifFile }} From 529e19cfb5c15986583fe9fa009bd4e214853bc8 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:50:14 -0400 Subject: [PATCH 68/73] Update greetings.yml --- .github/workflows/greetings.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 3e18a8eef..16f2dd7bf 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -1,4 +1,4 @@ -name: Greetings +name: Welcome new contributors on: [pull_request] From 38a437fe9772a22f10d5c55d1f6e6599921ad85e Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:51:44 -0400 Subject: [PATCH 69/73] Update label-actions.yml --- .github/workflows/label-actions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/label-actions.yml b/.github/workflows/label-actions.yml index 0c1ea3fe2..3a956daa2 100644 --- a/.github/workflows/label-actions.yml +++ b/.github/workflows/label-actions.yml @@ -1,4 +1,4 @@ -name: 'Label Actions' +name: 'Check for incomplete submissions' on: issues: From 28c04d4b146365426d27c5f4fc22a4cb1f3f8c10 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 14:52:22 -0400 Subject: [PATCH 70/73] Update greetings.yml --- .github/workflows/greetings.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index 16f2dd7bf..83d889240 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -1,4 +1,4 @@ -name: Welcome new contributors +name: 'Welcome new contributors' on: [pull_request] @@ -12,8 +12,8 @@ jobs: pr-message: | Thank you for submitting your first pull request! - We love celebrating the awesome work our contributors do on social media and community calls; Make sure that you update your GitHub user profile with your Twitter user name, your company name, and your picture. + We love 💖 celebrating the awesome work our contributors do on social media and community calls; Make sure that you update your GitHub user profile with your Twitter user name, your company name, and your picture. If you don't use a company name or Twitter account, we will assume that you prefer not to mention you on social media and/or that you do not want your company name listed. - Thank you for being awesome! + Thank you for being awesome 🚀! From b8960140f20265cfd6a490f1ebe26f7fa8ecf143 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 15:03:15 -0400 Subject: [PATCH 71/73] Update README.md --- samples/react-chartcontrol/README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/samples/react-chartcontrol/README.md b/samples/react-chartcontrol/README.md index a85620781..c02b0fda5 100644 --- a/samples/react-chartcontrol/README.md +++ b/samples/react-chartcontrol/README.md @@ -170,16 +170,7 @@ This sample shows how to use X and Y coordinate data elements in a scatter chart ## Compatibility -![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11-green.svg) - -![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg) - -![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-red.svg) - -![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg) - -![Workbench Local | Hosted](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg) - +![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11-green.svg) ![Node.js LTS 10.x](https://img.shields.io/badge/Node.js-LTS%2010.x-green.svg) ![SharePoint Online](https://img.shields.io/badge/SharePoint-Online-red.svg) ![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg) ![Workbench Local | Hosted](https://img.shields.io/badge/Workbench-Local%20%7C%20Hosted-green.svg) ## Applies to @@ -234,4 +225,12 @@ This Web Part sample pack illustrates the following concepts on top of the Share * Rendering conditional property pane fields * Creating custom property pane controls +## Support + +If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=react-chartcontrol&authors=@hugoabernier). + +For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=react-chartcontrol&authors=@hugoabernier). + +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=react-chartcontrol&authors=@hugoabernier). + From 75708e5cc0189bab022fa5bac1c67432f645b2b5 Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 15:22:57 -0400 Subject: [PATCH 72/73] Update README.md --- samples/react-chartcontrol/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/samples/react-chartcontrol/README.md b/samples/react-chartcontrol/README.md index c02b0fda5..195614320 100644 --- a/samples/react-chartcontrol/README.md +++ b/samples/react-chartcontrol/README.md @@ -227,10 +227,10 @@ This Web Part sample pack illustrates the following concepts on top of the Share ## Support -If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=react-chartcontrol&authors=@hugoabernier). +If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=react-chartcontrol&authors=@hugoabernier&title=react-chartcontrol%20-%20). -For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=react-chartcontrol&authors=@hugoabernier). +For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=react-chartcontrol&authors=@hugoabernier&title=react-chartcontrol%20-%20). -Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=react-chartcontrol&authors=@hugoabernier). +Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=react-chartcontrol&authors=@hugoabernier&title=react-chartcontrol%20-%20). From c3e923c3f77d5b3c92c576ba647b76ad51bb67aa Mon Sep 17 00:00:00 2001 From: Hugo Bernier Date: Sat, 24 Apr 2021 15:44:49 -0400 Subject: [PATCH 73/73] Update label-actions.yml --- .github/label-actions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/label-actions.yml b/.github/label-actions.yml index 655a3199c..3fd43f4bb 100644 --- a/.github/label-actions.yml +++ b/.github/label-actions.yml @@ -9,7 +9,7 @@ incomplete-submission: close: true # Actions taken when the `incomplete-submission` label is added to issues -type:incomplete-submission: +status:incomplete-submission: # Post a comment comment: > Thank you for your submission, but there isn't enough detail in the issue for us to review & move forward. The new issue template includes sections for you to fill out. Please resubmit your issue and complete the provided sections in the new item template so we can move forward on it refer to our wiki for more information: [How to Create Good Issues](https://github.com/pnp/sp-dev-fx-webparts/wiki/How-to-Create-Good-Issues)