From cf779decf55b2b11947f714c0338f77cf331a5af Mon Sep 17 00:00:00 2001 From: advaiyalad Date: Thu, 8 Apr 2021 10:57:10 -0500 Subject: [PATCH 1/4] chore(issue-templates): create issue templates Adds issue templates and config.yml --- .github/ISSUE_TEMPLATE/bug-report.md | 22 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/docs.md | 15 ++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 23 +++++++++++++++++ .github/ISSUE_TEMPLATE/meta.md | 7 ++++++ .github/ISSUE_TEMPLATE/new-module.md | 26 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/validation.md | 30 +++++++++++++++++++++++ 7 files changed, 124 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/meta.md create mode 100644 .github/ISSUE_TEMPLATE/new-module.md create mode 100644 .github/ISSUE_TEMPLATE/validation.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..949915b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,22 @@ +--- +name: Bug Report +about: Create a report to help the library improve +labels: bug +--- + +# Bug Report + +## Describe the bug + + +## Minimal Reproduction + + +## Environment +Browser or Node: +Node version (if applicable): +Npm version: +Browser verion (if applicable): +Library version (e.g. `1.10.1`): + +## Additional Context diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs.md b/.github/ISSUE_TEMPLATE/docs.md new file mode 100644 index 00000000..35ead2c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.md @@ -0,0 +1,15 @@ +--- +name: Docs Improvement +about: Suggest an improvement to the docs or README.md +labels: documentation +--- + +# Docs Improvment + +**:exclamation: THIS IS NOT FOR TYPOS!!! PLEASE JUST FILE A PR FOR THAT! THIS IS FOR SUBSTANTIAL IMPROVEMENTS *ONLY*!** + +## Suggested Improvement + + +## Reason For Suggestion (if not related to a module) + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..397cc4f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,23 @@ +--- +name: Feature Request +about: Suggest an idea or feature +labels: enhancement +--- + +# Feature Request + +## Wanted Feature + + +## Use Cases + +- +- +- + +## Potential Example Usage +This feature *could* be used in the following way: +```ts +// something here, please fill this out +``` + diff --git a/.github/ISSUE_TEMPLATE/meta.md b/.github/ISSUE_TEMPLATE/meta.md new file mode 100644 index 00000000..4546903d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/meta.md @@ -0,0 +1,7 @@ +--- +name: Meta Issue +about: Plans, roadmaps, and other meta issues +labels: meta +--- + + diff --git a/.github/ISSUE_TEMPLATE/new-module.md b/.github/ISSUE_TEMPLATE/new-module.md new file mode 100644 index 00000000..0f1228b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-module.md @@ -0,0 +1,26 @@ +--- +name: New Module Request +about: Suggest a new module +labels: enhancement, new module +--- + +# Feature Request + +## Wanted Module + + +## Endpoint (if you found one) + +`https://...` + +### Query Params +| Name | Type | Required | +| ---- | ---- | -------- | +| | | | + +## Potential Example Usage +This module *could* be used in the following way: +```ts +// something here, please fill this out +``` + diff --git a/.github/ISSUE_TEMPLATE/validation.md b/.github/ISSUE_TEMPLATE/validation.md new file mode 100644 index 00000000..38f30f97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/validation.md @@ -0,0 +1,30 @@ +--- +name: Validation Error +about: Something went wrong with validation +labels: bug, validation +--- + +# Validation Error + +## Minimal Reproduction + + +## Symbol(s) that it happened for +- +- +- + +## Error Message + +``` + +``` + +## Environment +Browser or Node: +Node version (if applicable): +Npm version: +Browser verion (if applicable): +Library version (e.g. `1.10.1`): + +## Additional Context From 30fa918b9a2f5d555d3e677807494d16b000cf48 Mon Sep 17 00:00:00 2001 From: advaiyalad Date: Thu, 8 Apr 2021 11:18:30 -0500 Subject: [PATCH 2/4] chore(pr-templates): add pr template --- .github/pull_reequest_template.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/pull_reequest_template.md diff --git a/.github/pull_reequest_template.md b/.github/pull_reequest_template.md new file mode 100644 index 00000000..de1526e0 --- /dev/null +++ b/.github/pull_reequest_template.md @@ -0,0 +1,13 @@ +Closes # . + +## Changes +- +- +- + +## Type +- [ ] New Module +- [ ] Other New Feature +- [ ] Validation Fix +- [ ] Other Bugfix +- [ ] Docs \ No newline at end of file From 531ea9219c27b4913efaefaffc3323fa3e2e77a9 Mon Sep 17 00:00:00 2001 From: advaiyalad Date: Thu, 8 Apr 2021 11:20:53 -0500 Subject: [PATCH 3/4] chore(pr-template): add chore as type --- .github/pull_reequest_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_reequest_template.md b/.github/pull_reequest_template.md index de1526e0..ae2045ed 100644 --- a/.github/pull_reequest_template.md +++ b/.github/pull_reequest_template.md @@ -10,4 +10,5 @@ Closes # . - [ ] Other New Feature - [ ] Validation Fix - [ ] Other Bugfix -- [ ] Docs \ No newline at end of file +- [ ] Docs +- [ ] Chore/other \ No newline at end of file From f6f24207811a8b043f28b83933ff9fc16e694cb1 Mon Sep 17 00:00:00 2001 From: advaiyalad Date: Thu, 8 Apr 2021 11:22:13 -0500 Subject: [PATCH 4/4] chore(pr-template): add notes section --- .github/pull_reequest_template.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/pull_reequest_template.md b/.github/pull_reequest_template.md index ae2045ed..8242febb 100644 --- a/.github/pull_reequest_template.md +++ b/.github/pull_reequest_template.md @@ -11,4 +11,7 @@ Closes # . - [ ] Validation Fix - [ ] Other Bugfix - [ ] Docs -- [ ] Chore/other \ No newline at end of file +- [ ] Chore/other + +## Comments/notes + \ No newline at end of file