Merge remote-tracking branch 'upstream/master'

This commit is contained in:
albegut 2021-04-25 14:03:42 +02:00
commit f180b47339
21 changed files with 607 additions and 215 deletions

164
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,164 @@
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. 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.
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
id: sample
validations:
required: true
attributes:
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?
- 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.
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
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: Describe the observed behavior
placeholder: Tell us what you see!
validations:
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.
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: expected
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
- 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.
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:
label: Target SharePoint environment
options:
- SharePoint Online
- SharePoint Server 2019 (on-premise)
- SharePoint Server 2016 (on-premise)
- type: dropdown
id: environment-os
attributes:
label: Developer environment
options:
- Windows
- macOS
- Linux
- type: checkboxes
id: browsers
attributes:
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
- 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: input
id: spfx
validations:
required: true
attributes:
label: SPFx version
placeholder: 1.11.0
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
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
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.

View File

@ -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

View File

@ -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)_

View File

@ -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)_

56
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@ -0,0 +1,56 @@
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.
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
id: question
attributes:
label: Question
description: What would you like to know?
placeholder: The more details, the better
validations:
required: true

View File

@ -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?

View File

@ -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

64
.github/ISSUE_TEMPLATE/suggestion.yml vendored Normal file
View File

@ -0,0 +1,64 @@
name: 💡 Suggestion
description: Suggest an enhancement to make one of our web part samples even better
labels: ['Needs: Triage :mag:', '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. 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.
- 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: dropdown
id: willing-to-help
attributes:
label: Are you willing to help?
description: Would you be willing to help us make this improvement?
options:
- "Yes"
- "No"
validations:
required: true

View File

@ -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/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.

View File

@ -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)

93
.github/question.yml vendored Normal file
View File

@ -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

67
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@ -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

View File

@ -1,4 +1,4 @@
name: Greetings
name: 'Welcome new contributors'
on: [pull_request]
@ -9,11 +9,11 @@ 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.
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 🚀!

View File

@ -1,4 +1,4 @@
name: 'Label Actions'
name: 'Check for incomplete submissions'
on:
issues:

44
.github/workflows/ossar-analysis.yml vendored Normal file
View File

@ -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 }}

9
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,9 @@
# 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.
Remember that this repository is maintained by community members who volunteer their time to help. Be courteous and patient.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/CODE_OF_CONDUCT.md" />

View File

@ -194,4 +194,4 @@ Thank you for your contribution.
> Sharing is caring.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/.github/CONTRIBUTING.md" />
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/CONTRIBUTING.md" />

View File

@ -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
@ -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.

18
SECURITY.md Normal file
View File

@ -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.

36
SUPPORT.md Normal file
View File

@ -0,0 +1,36 @@
## 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/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.
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/SUPPORT.md" />

View File

@ -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&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&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&title=react-chartcontrol%20-%20).
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-chartcontrol" />