diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml index 647707a..4f2c3f0 100644 --- a/.github/ISSUE_TEMPLATE/1-bug.yml +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -6,6 +6,7 @@ body: * is this really a problem? * is this a problem here? * can this be solved in a different way? + * can this be contributed as a PR with a failing test instead? type: markdown - attributes: label: Initial checklist @@ -16,74 +17,78 @@ body: required: true - label: I agree to follow the [code of conduct](https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md) 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) + - label: I searched [issues](https://github.com/search?q=user%3Asyntax-tree&type=issues) and [discussions](https://github.com/orgs/syntax-tree/discussions) and couldn’t find anything (or linked relevant results below) required: true 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 + Which packages cause the bug? + Please test using latest versions. + Example: `some-package@1.2.3`. + label: Affected package id: affected-versions type: input validations: required: true - - attributes: - description: | - Link to repository or sandbox with runnable example of the issue. - Alternatively use the next section *Steps to reproduce*. - label: Link to runnable example - id: runnable-example - type: input - validations: - required: false - attributes: description: | How did this happen? - Please provide a [minimal and reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). + + Provide a [minimal and reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). + Link to a repository or sandbox or show the code here. + Remove everything that is not needed. + Use plain Node and npm if possible. label: Steps to reproduce id: steps-to-reproduce type: textarea validations: required: true - attributes: - description: What should happen? - label: Expected behavior - id: expected-behavior + description: | + What happens? + What is wrong with the current behavior? + label: Actual behavior + id: actual-behavior type: textarea validations: required: true - attributes: - description: What happens instead? - label: Actual behavior - id: actual-behavior + description: | + What should happen instead? + Why should that happen? + Why is that better than the current behavior? + label: Expected behavior + id: expected-behavior type: textarea validations: required: true - attributes: - label: Affected runtime and version + label: Runtime description: | - What runtime are you using (such as `node@18.2` or `deno@1.12.2`)? - Please test using the latest version. + What runtime are you using? + Please test using latest versions. + Example: `node@23.2.0` or `Chrome 131.0.6778.86`. id: runtime type: input validations: - required: true + required: false - attributes: description: | - What package manager are you using (such as `npm@8.9.0`)? - Please test using the latest version. - label: Affected package manager and version + What package manager are you using? + Please test using latest versions. + Example: `npm@10.9.0`. + label: Package manager id: package-manager type: input validations: required: false - attributes: description: | - What operating system are you using (such as `macOS Monterey 12.4`)? - Please test using the latest version. - label: Affected OS and version + What operating system are you using? + Please test using latest versions. + Example: `macOS Sequoia 15.1.1`. + label: Operating system id: operating-system type: input validations: @@ -91,7 +96,7 @@ body: - attributes: description: | What tools are used to build or bundle the project? - Please test using the latest version. + Please test using latest versions. label: Build and bundle tools multiple: true options: @@ -112,5 +117,5 @@ body: type: dropdown validations: required: false -description: Describe a bug with a project -name: 🐛 Bug report +description: Report a bug +name: 🐛 Bug diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml index bc92213..af901b0 100644 --- a/.github/ISSUE_TEMPLATE/2-feature.yml +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -15,12 +15,20 @@ body: required: true - label: I agree to follow the [code of conduct](https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md) 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) + - label: I searched [issues](https://github.com/search?q=user%3Asyntax-tree&type=issues) and [discussions](https://github.com/orgs/syntax-tree/discussions) and couldn’t find anything (or linked relevant results below) required: true id: initial-checklist type: checkboxes - attributes: - description: Please describe the problem you are trying to solve here. + description: | + Please describe the problem. + + Forget about the particular solution you have in mind. + Solution time is later! + + What is missing? What are the use cases? + Describe which use cases are important and which are nice to have. + Convince the maintainers that there is a real problem. label: Problem id: problem type: textarea @@ -28,21 +36,21 @@ body: required: true - attributes: description: | - What should happen? - Please describe the desired behavior. - label: Solution - id: solution + Are there existing solutions? + Can these use cases be addressed already? + label: Current solutions + id: alternatives type: textarea validations: required: true - attributes: description: | - What are the alternative solutions? - Can this be solved in a different way? - label: Alternatives - id: alternatives + What is a better solution? + Why is that better than current solutions at addressing the use cases? + label: Proposed solutions + id: solution type: textarea validations: required: true description: Suggest an idea -name: 🚀 Feature request +name: 🚀 Feature diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 184e9fd..34f00ef 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - about: Ask questions and discuss with other community members - name: 🙋 Ask a question + name: 💬 Discussions url: https://github.com/syntax-tree/unist/discussions diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index d26c5c2..0a61bae 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -1,9 +1,13 @@ ### Initial checklist @@ -11,8 +15,9 @@ * [ ] I read the support docs * [ ] I read the contributing guide * [ ] I agree to follow the code of conduct -* [ ] I searched issues and couldn’t find anything (or linked relevant results below) -* [ ] I’ve added docs and tests or that’s not applicable +* [ ] I searched issues and discussions and couldn’t find anything or linked relevant results below +* [ ] I made sure the docs are up to date +* [ ] I included tests (or that’s not needed) ### Description of changes