diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml index 4d9732b..066f778 100644 --- a/.github/ISSUE_TEMPLATE/1-bug.yml +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -1,17 +1,13 @@ -name: 🐛 Bug report -description: Describe a bug with a project body: - - type: markdown - attributes: + - attributes: value: | Some general tips: * Is this really a problem? * Is this a problem here? * Can this be solved in a different way? - - type: checkboxes - id: initial-checklist - attributes: + type: markdown + - attributes: label: Initial checklist options: - label: I read the [support docs](https://github.com/syntax-tree/.github/blob/main/support.md) @@ -22,99 +18,99 @@ body: required: true - label: I searched [issues](https://github.com/search?q=user%3Asyntax-tree&type=Issues) and couldn’t find anything (or linked relevant results below) required: true - - type: input - id: affected-versions - attributes: + id: initial-checklist + type: checkboxes + - attributes: + description: | + Please test using the latest version of the relevant packages to make + sure your issue has not already been fixed. label: Affected packages and versions - description: Please test using the latest version of the relevant packages to make sure your issue has not already been fixed. + id: affected-versions + type: input validations: required: true - - type: input - id: runnable-example - attributes: - label: Link to runnable example + - attributes: description: | Link to repository or sandbox with runnable example of the issue. Alternatively, use the next section *Steps to reproduce*. - - Some starters: - - | description | codesandbox | stackblitz | - | - | - | - | - | remark only (for markdown to markdown) | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/remark-with-parcel) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/remark-with-parcel) | - | remark and rehype (for markdown to html) | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/remark-rehype-with-parcel) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/remark-rehype-with-parcel) | - | react-markdown | [codesandbox](https://codesandbox.io/s/github/remarkjs/.github/tree/main/sandbox-templates/react-markdown-with-create-react-app) | [stackblitz](https://stackblitz.com/github/remarkjs/.github/tree/main/sandbox-templates/react-markdown-with-create-react-app) | + label: Link to runnable example + id: runnable-example + type: input validations: required: false - - type: textarea - id: steps-to-reproduce - attributes: + - attributes: + description: | + How did this happen? + Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). label: Steps to reproduce - description: How did this happen? Please provide a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). + id: steps-to-reproduce + type: textarea validations: required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected behavior + - attributes: description: What should happen? + label: Expected behavior + id: expected-behavior + type: textarea validations: required: true - - type: textarea - id: actual-behavior - attributes: - label: Actual behavior + - attributes: description: What happens instead? + label: Actual behavior + id: actual-behavior + type: textarea validations: required: true - - type: input - id: runtime - attributes: + - attributes: label: Affected runtime and version description: | - What runtime are you using (e.g., `node@18.2`, `deno@1.12.2`)? + What runtime are you using (such as `node@18.2`, `deno@1.12.2`)? Please test using the latest version. + id: runtime + type: input validations: required: true - - type: input - id: package-manager - attributes: - label: Affected package manager and version + - attributes: description: | - What package manager are you using (e.g., `npm@8.9.0`)? + What package manager are you using (such as `npm@8.9.0`)? Please test using the latest version. + label: Affected package manager and version + id: package-manager + type: input validations: required: false - - type: input - id: operating-system - attributes: - label: Affected OS and version + - attributes: description: | - What operating system are you using (e.g., `macOS Monterey 12.4`)? + What operating system are you using (such as `macOS Monterey 12.4`)? Please test using the latest version. + label: Affected OS and version + id: operating-system + type: input validations: required: false - - type: dropdown - id: build-tools - attributes: - label: Build and bundle tools + - attributes: description: | What, if any, tools are used to build or bundle the project? Please test using the latest version. + label: Build and bundle tools multiple: true options: - - webpack - - Rollup - - esbuild - - swc - - Parcel - - CRA (Create React App) - - Vite - - Next.js - - Remix - Astro + - CRA (Create React App) - Docusaurus - Gatsby - - Other (please specify in steps to reproduce) + - Next.js + - Parcel + - Remix + - Rollup + - Vite + - esbuild + - swc + - webpack + - other (please specify in steps to reproduce) + id: build-tools + type: dropdown validations: required: false +description: Describe a bug with a project +name: 🐛 Bug report diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml index 3356314..b6df735 100644 --- a/.github/ISSUE_TEMPLATE/2-feature.yml +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -1,16 +1,12 @@ -name: 🚀 Feature request -description: Suggest an idea body: - - type: markdown - attributes: + - attributes: value: | Some general tips: * Is this really a problem? * Is this a problem here? - - type: checkboxes - id: initial-checklist - attributes: + type: markdown + - attributes: label: Initial checklist options: - label: I read the [support docs](https://github.com/syntax-tree/.github/blob/main/support.md) @@ -21,24 +17,32 @@ body: required: true - label: I searched [issues](https://github.com/search?q=user%3Asyntax-tree&type=Issues) and couldn’t find anything (or linked relevant results below) required: true - - type: textarea - id: problem - attributes: - label: Problem + id: initial-checklist + type: checkboxes + - attributes: description: Please describe the problem you are trying to solve here. + label: Problem + id: problem + type: textarea validations: required: true - - type: textarea - id: solution - attributes: + - attributes: + description: | + What should happen? + Please describe the desired behavior. label: Solution - description: What should happen? Please describe the desired behavior. + id: solution + type: textarea validations: required: true - - type: textarea - id: alternatives - attributes: + - attributes: + description: | + What are the alternative solutions? + Can this be solved in a different way? label: Alternatives - description: What are the alternative solutions? Can this be solved in a different way? + id: alternatives + type: textarea validations: required: true +description: Suggest an idea +name: 🚀 Feature request diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 114756a..184e9fd 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: 🙋 Ask a question + - about: Ask questions and discuss with other community members + name: 🙋 Ask a question url: https://github.com/syntax-tree/unist/discussions - about: Ask questions and discuss with other community members diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index d898b91..920a289 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,9 +1,9 @@ ### Initial checklist