diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..f328461 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,26 @@ +name: Report a bug +description: Issue for reporting a bug +title: 'Bug: ' +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thank you for helping to improve our project! Please fill in the following information: + + - type: textarea + attributes: + label: The part of the code where the error occurred + description: Copy the part of the code where the error occurred + placeholder: | + ```html +
+ +
+ ``` + + - type: textarea + attributes: + label: Description of the bug + description: Please provide a detailed description of the bug diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..8276fe3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,21 @@ +name: Request a feature +description: Issue for requesting a feature +title: 'Feature: ' +labels: + - feature +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to share your ideas + + - type: textarea + attributes: + label: Brief description + description: Provide a brief description in your own words about what the rule will check + placeholder: Support for a new HTML element... + + - type: textarea + attributes: + label: Freeform description field + description: Add anything else you wanted to share here diff --git a/.ls-lint.yml b/.ls-lint.yml index 4746c2b..aba26de 100644 --- a/.ls-lint.yml +++ b/.ls-lint.yml @@ -1,6 +1,8 @@ ls: .dir: regex:([.a-z]*)([-.][a-z]+)* .ts: regex:([.a-z]*)([-.][a-z]+)* + .github/ISSUE_TEMPLATE: + .dir: SCREAMING_SNAKE_CASE ignore: - node_modules diff --git a/readme.md b/readme.md index 69f7db1..66dfd32 100644 --- a/readme.md +++ b/readme.md @@ -17,7 +17,7 @@ npm install form-payload - [Advanced (TypeScript + Validation)](https://stackblitz.com/edit/form-payload-advanced?file=index.ts,get-form-payload.ts) - [Framework (React + TypeScript)](https://stackblitz.com/edit/form-payload-framework?file=src%2FApp.tsx) -PS. _The library works perfectly with any framework. Just use a valid [HTMLFormElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement). The same applies to validations and any other libraries. Just create your own wrappers on top of the functions exported by form-payload library._ +PS. _The library works perfectly with any framework. Just use a valid [HTMLFormElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement). The same applies to validations and any other libraries. Just create your own wrappers on top of the functions exported by **form-payload** library._ ## Usage