-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): preparing docs for release
- Loading branch information
Showing
22 changed files
with
631 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
name: Bug Report | ||
about: File a bug report | ||
title: "bug - [plugin/module] - bug title" | ||
labels: "bug report" | ||
assignees: "" | ||
--- | ||
|
||
## Thanks for creating an issue 😄! | ||
|
||
Please search open/closed issues before submitting. Someone might have asked the same thing before. | ||
To help us, please take the time to accurately fill out this template. ❤️ | ||
|
||
#### 1. Describe the bug: | ||
|
||
> A brief description of the issue. | ||
> Ex: When I \_**\_, I expected \_\_** to happen but \_\_\_\_ happened instead. | ||
--- | ||
|
||
#### 2. Version: | ||
|
||
> The version of this library that are using. | ||
--- | ||
|
||
#### 3. Link to Reproduction: | ||
|
||
> A link to a CodeSandbox or any other sandbox service which demonstrates the bug (see https://github.com/accezar/multi-package-start#codesandbox-templates for templates) | ||
--- | ||
|
||
#### 4. Steps to reproduce | ||
|
||
> 1. Go to '...' | ||
> 2. Click on '....' | ||
> 3. Scroll down to '....' | ||
> 4. See error | ||
--- | ||
|
||
#### 5. Screenshots | ||
|
||
> If applicable, add screenshots to help explain your problem. | ||
--- | ||
|
||
#### 6. Desktop (please complete the following information): | ||
|
||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
--- | ||
|
||
#### 7. Additional context | ||
|
||
> Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
name: "Bug Report" | ||
description: "File a bug report" | ||
labels: ["bug report"] | ||
body: | ||
- type: "markdown" | ||
attributes: | ||
value: | | ||
Thanks for creating an issue 😄! | ||
Please search open/closed issues before submitting. Someone | ||
might have asked the same thing before 😉! | ||
We're all volunteers here, so help us help you by taking the time to | ||
accurately fill out this template. ❤️ | ||
- type: "input" | ||
id: "description" | ||
attributes: | ||
label: "Description" | ||
description: "A brief description of the issue." | ||
placeholder: | | ||
When I ____, I expected ____ to happen but ____ happened instead. | ||
validations: | ||
required: true | ||
- type: "input" | ||
id: "reproduction" | ||
attributes: | ||
label: "Link to Reproduction" | ||
description: | | ||
A link to a env reproduction which demonstrates the bug (see https://codesandbox.io/for | ||
templates) | ||
placeholder: "https://codesandbox.io/" | ||
validations: | ||
required: true | ||
- type: "textarea" | ||
id: "steps" | ||
attributes: | ||
label: "Steps to reproduce" | ||
description: | | ||
Explain how to cause the issue in the provided reproduction. | ||
value: | | ||
1. Go to '...' | ||
2. Click on '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
- type: "input" | ||
id: "lib-version" | ||
attributes: | ||
label: "Plugin Version" | ||
description: "The version of plugin you use." | ||
placeholder: "0.0.0" | ||
validations: | ||
required: true | ||
- type: "input" | ||
id: "browser" | ||
attributes: | ||
label: "Browser" | ||
description: "The browser(s) this issue occurred with." | ||
placeholder: "Google Chrome 93" | ||
- type: "checkboxes" | ||
id: "operating-system" | ||
attributes: | ||
label: "Operating System" | ||
description: "The operating system(s) this issue occurred with." | ||
options: | ||
- label: "macOS" | ||
- label: "Windows" | ||
- label: "Linux" | ||
- type: "textarea" | ||
id: "additional-information" | ||
attributes: | ||
label: "Additional Information" | ||
description: | | ||
Use this section to provide any additional information you might have | ||
like screenshots, notes, or links to ideas. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Documentation Request | ||
about: Request for documentation to be added/altered | ||
title: 'doc - [plugin] - request title' | ||
labels: 'needs triage' | ||
assignees: '' | ||
--- | ||
|
||
## Thanks for filing a documentation request 📚! | ||
|
||
If you have an idea for a new documentation topic, noticed that something is not properly | ||
documented, or feel that something is incorrect with the current documentation, you're in the right | ||
place! | ||
|
||
#### 1. Subject: | ||
|
||
What is the subject (plugin, function, topic) of this request? | ||
|
||
> Ex: Plugin Page | ||
--- | ||
|
||
#### 2. Description: | ||
|
||
What about the subject's documentation should be added or changed? | ||
|
||
> Ex: Add a usage example of Plugin Page in action |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: "Documentation Request" | ||
description: "Request for documentation to be added/altered" | ||
labels: ["needs triage"] | ||
body: | ||
- type: "markdown" | ||
attributes: | ||
value: | | ||
Thanks for filing a documentation request 📚! | ||
If you have an idea for a new documentation topic, noticed that | ||
something is not properly documented, or feel that something is | ||
incorrect with the current documentation, you're in the right place! | ||
- type: "input" | ||
id: "subject" | ||
attributes: | ||
label: "Subject" | ||
description: "What is the subject (plugin, feature, topic) of this request?" | ||
placeholder: "RadioGroup" | ||
validations: | ||
required: true | ||
- type: "textarea" | ||
id: "description" | ||
attributes: | ||
label: "Description" | ||
description: "What about the subject's documentation should be added or changed?" | ||
placeholder: "Add a usage example of RadioGroup in action" | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
name: Feature Request | ||
about: Request a feature or enhancement | ||
title: 'feat - [plugin/context] - feature request title' | ||
labels: 'needs triage' | ||
assignees: '' | ||
--- | ||
|
||
## Thanks for filing an issue 😄! | ||
|
||
Please search open/closed issues before submitting. Someone might have asked the same thing before | ||
😉! | ||
|
||
#### 1. Description: | ||
|
||
Please describe your request in one or two sentences: | ||
|
||
> ... | ||
--- | ||
|
||
#### 2. Problem Statement/Justification: | ||
|
||
Please provide valid reason(s) why this should be added. If this feature is related to a problem | ||
you've noticed, mention it as well. | ||
|
||
> ... | ||
--- | ||
|
||
#### 3. Proposed Solution or AP: | ||
|
||
Please provide valid reason(s) why this should be added. If this feature is related to a problem | ||
you've noticed, mention it as well. | ||
|
||
> ... | ||
--- | ||
|
||
#### 4. Alternatives: | ||
|
||
What alternative solutions have you considered before making this request? | ||
|
||
> ... | ||
--- | ||
|
||
#### 5. Additional Information: | ||
|
||
What resources (links, screenshots, etc.) do you have to assist this effort? | ||
|
||
> ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: 'Feature Request' | ||
description: 'Request a feature or enhancement' | ||
labels: ['needs triage'] | ||
body: | ||
- type: 'markdown' | ||
attributes: | ||
value: | | ||
Thanks for filing an issue 😄! | ||
Please search open/closed issues before submitting. Someone | ||
might have asked the same thing before 😉! | ||
- type: 'textarea' | ||
id: 'description' | ||
attributes: | ||
label: 'Description' | ||
description: 'Please describe your request in one or two sentences.' | ||
validations: | ||
required: true | ||
- type: 'textarea' | ||
id: 'justification' | ||
attributes: | ||
label: 'Problem Statement/Justification' | ||
description: | | ||
Please provide valid reason(s) why this should be added | ||
If this feature is related to a problem you've noticed, mention it as | ||
well. | ||
validations: | ||
required: true | ||
- type: 'textarea' | ||
id: 'proposed-solution' | ||
attributes: | ||
label: 'Proposed Solution or API' | ||
description: | | ||
Please provide code snippets, gists, or links to the ideal | ||
design or API. | ||
validations: | ||
required: true | ||
- type: 'textarea' | ||
id: 'alternatives' | ||
attributes: | ||
label: 'Alternatives' | ||
description: | | ||
What alternative solutions have you considered before making this | ||
request? | ||
- type: 'textarea' | ||
id: 'additional-information' | ||
attributes: | ||
label: 'Additional Information' | ||
description: | | ||
What resources (links, screenshots, etc.) do you have to assist this | ||
effort? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
<!--- | ||
Thanks for creating an Pull Request 💖! | ||
Please read the following before submitting: | ||
- PRs that adds new external dependencies might take a while to review. | ||
- Keep your PR as small as possible. | ||
- Limit your PR to one type (docs, feat, refact, ci, or bugfix) | ||
- Remove this comment | ||
--> | ||
|
||
### 📝 Description | ||
|
||
> Add a brief description | ||
### ⛳️ Current behavior | ||
|
||
> Please describe the current behavior that you are modifying | ||
> | ||
> - Currently the plugin does... | ||
### 🚀 New behavior | ||
|
||
> Please describe the behavior or changes this PR adds | ||
> | ||
> - Change one here.. | ||
> - Change two here.. | ||
> - Change three here.. | ||
### 💣 Is this a breaking change (Yes/No): | ||
|
||
> If Yes, please describe the impact and migration steps for existing users. | ||
### 📝 Additional Information | ||
|
||
### Checklist | ||
|
||
- [ ] Have you written tests for your changes? | ||
- [ ] Have you successfully ran tests with your changes locally? | ||
- [ ] Have you lint your code locally prior to submission? | ||
- [ ] Have you updated the plugin documentation with the changes? |
Empty file.
Oops, something went wrong.