Skip to content

Commit

Permalink
Add new issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
juliemturner committed Jul 24, 2023
1 parent a5c7745 commit ec55b4c
Show file tree
Hide file tree
Showing 3 changed files with 209 additions and 0 deletions.
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: 🐞 Bug or Error Report
description: Submit a bug or error report.
labels: ["type: something isn't working", "status: investigate"]

body:
- type: markdown
attributes:
value: |
This issue type is for submitting bugs or errors you believe you have found with the PnPjs library. If your submission references permission errors or 5xx status code responses, this is almost certainly not a bug with PnPjs but rather and issue with your configuration, please refer to other support options listed on the [new issue chooser page](https://github.dev/juliemturner/pnpjs/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.dev/juliemturner/pnpjs/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.
- type: dropdown
attributes:
label: Major Version
options:
- 4.x
- 3.x
- 2.x (No longer supported)
- 1.x (No longer supported)
validations:
required: true
- type: input
id: minorver
attributes:
label: Minor Version Number
description: Include the minor and patch version numbers, e.g. for 4.1.0
placeholder: '1.0'
validations:
required: true
- type: dropdown
attributes:
label: Target environment
options:
- All
- SharePoint Framework
- NodeJS
- Browser App (Hosted external to Microsoft 365 platform)
- other (enter in the "Additional environment details" area below)
validations:
required: true
- type: textarea
attributes:
label: Additional environment details
description: Please describe the environment you're working in and how you're authenticating.
placeholder: |
I'm using NodeJS and certificate based MSAL for authentication.
validations:
required: true
- type: textarea
attributes:
label: Expected or Desired Behavior
description: Describe what you are trying to accomplish.
placeholder: |
I'm trying to get items from a list in a site.
validations:
required: true
- type: textarea
attributes:
label: Observed Behavior
description: Describe the results you're getting.
placeholder: |
I'm getting an empty response
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Please included code fenced example code, OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured. See the sample above.
placeholder: |
Here is the code I'm running
```TypeScript
import { spfi } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
const sp = spfi(...);
// get all the items from a list
const items: any[] = await sp.web.lists.getByTitle("My List").items();
console.log(items);
```
validations:
required: true


49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: 🏗 Enhancement
description: Suggest an enhancement
labels: ["type: enhancement", "status: investigate"]

body:
- type: markdown
attributes:
value: |
This issue type is for suggesting or discussing enhancements to the library.
- Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/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.
- type: dropdown
attributes:
label: Target environment
options:
- All
- SharePoint Framework
- NodeJS
- Browser App (Hosted external to Microsoft 365 platform)
- other (enter in the "Additional environment details" area below)
validations:
required: false
- type: textarea
attributes:
label: Additional environment details
description: Please describe the environment you're working in and how you're authenticating.
placeholder: |
I'm using NodeJS and certificate based MSAL for authentication.
- type: textarea
attributes:
label: Enhancement Idea
description: Please included details to describe your situation, code fenced example code OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured and get you the right help more quickly.
placeholder: |
I'm struggling to get a list item. Here is the code I'm running. Can anyone help me figure out what's wrong?
```TypeScript
import { spfi } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
const sp = spfi(...);
// get all the items from a list
const items: any[] = await sp.web.lists.getByTitle("My List").items();
console.log(items);
```
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: ❓ Question/Assistance Needed
description: Ask a question or seek guidance
labels: ["type: question", "help wanted 🐇"]

body:
- type: markdown
attributes:
value: |
This issue type is for asking questions or requesting assistance in using the library. Please provide as much information as possible so a member of the community can best assist you. Thanks!
- Follow our guidance on [How To Create Good Issues](https://github.dev/juliemturner/pnpjs/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.
- type: dropdown
attributes:
label: What version of PnPjs library you are using
options:
- 4.x
- 3.x
- 2.x (No longer supported)
- 1.x (No longer supported)
validations:
required: true
- type: input
id: minorver
attributes:
label: Minor Version Number
description: Include the minor and patch version numbers, e.g. for 4.1.0
placeholder: '1.0'
validations:
required: true
- type: dropdown
attributes:
label: Target environment
options:
- All
- SharePoint Framework
- NodeJS
- Browser App (Hosted external to Microsoft 365 platform)
- other (enter in the "Additional environment details" area below)
validations:
required: true
- type: textarea
attributes:
label: Additional environment details
description: Please describe the environment you're working in and how you're authenticating.
placeholder: |
I'm using NodeJS and certificate based MSAL for authentication.
validations:
required: true
- type: textarea
attributes:
label: Question/Request
description: Please included details to describe your situation, code fenced example code OR a link to a code snippet using GitHub or CodePen or the like to show how your code is structured and get you the right help more quickly.
placeholder: |
I'm struggling to get a list item. Here is the code I'm running. Can anyone help me figure out what's wrong?
```TypeScript
import { spfi } from "@pnp/sp";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
const sp = spfi(...);
// get all the items from a list
const items: any[] = await sp.web.lists.getByTitle("My List").items();
console.log(items);
```
validations:
required: true

0 comments on commit ec55b4c

Please sign in to comment.