diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/1-bug-report.yml | 44 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/1-install-problem.yml | 35 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/2-bug-report.yml | 44 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/2-feature-request.yml | 25 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.yml | 18 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/3-feature-request.yml | 24 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/4-docs-problem.yml | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 4 |
8 files changed, 136 insertions, 89 deletions
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml deleted file mode 100644 index 49feea655..000000000 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: 🐛 Bug report -description: Create a report to help us improve -labels: [bug, need repro] -body: - - type: markdown - attributes: - value: | - Thank you for reporting an issue. - - This issue tracker is for bugs and issues found within bun. - If you require more general support please reach out to our [discord server](https://bun.sh/discord). - - Please fill in as much of the following form as you're able. - - type: input - attributes: - label: Version - description: Output of `bun -v` - - type: input - attributes: - label: Platform - description: | - UNIX: output of `uname -a` - Windows: output of `"$([Environment]::OSVersion | ForEach-Object VersionString) $(if ([Environment]::Is64BitOperatingSystem) { "x64" } else { "x86" })"` in PowerShell console - - type: textarea - attributes: - label: What steps will reproduce the bug? - description: Enter details about your bug, preferably a simple code snippet that can be run using `bun` directly without installing third-party dependencies. - - type: textarea - attributes: - label: How often does it reproduce? Is there a required condition? - - type: textarea - attributes: - label: What is the expected behavior? - description: If possible, please provide textual output instead of screenshots. - - type: textarea - attributes: - label: What do you see instead? - description: If possible, please provide textual output instead of screenshots. - validations: - required: true - - type: textarea - attributes: - label: Additional information - description: Tell us anything else you think we should know. diff --git a/.github/ISSUE_TEMPLATE/1-install-problem.yml b/.github/ISSUE_TEMPLATE/1-install-problem.yml new file mode 100644 index 000000000..c9b399052 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-install-problem.yml @@ -0,0 +1,35 @@ +name: 📥 Install Problem +description: Report an issue during install or upgrade +labels: [bug, install] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a bug report. It helps make Bun better. + + If you need help or support using Bun, and are not reporting an issue, please + join our [Discord](https://discord.gg/CXdq2DP29u) server, where you can ask questions in the [`#help`](https://discord.gg/32EtH6p7HN) forum. + + Please try to include as much information as possible. + - type: input + attributes: + label: What platform is your computer? + description: | + For MacOS and Linux: copy the output of `uname -mprsv` + For Windows: copy the output of `"$([Environment]::OSVersion | ForEach-Object VersionString) $(if ([Environment]::Is64BitOperatingSystem) { "x64" } else { "x86" })"` in the PowerShell console + - type: textarea + attributes: + label: How did you attempt to install or upgrade? + description: Please provide the commands you ran to install or upgrade. + validations: + required: true + - type: textarea + attributes: + label: What do you see instead? + description: If possible, please provide text instead of a screenshot. + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Is there anything else you think we should know? diff --git a/.github/ISSUE_TEMPLATE/2-bug-report.yml b/.github/ISSUE_TEMPLATE/2-bug-report.yml new file mode 100644 index 000000000..77ad422c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug-report.yml @@ -0,0 +1,44 @@ +name: 🐛 Bug Report +description: Report an issue that should be fixed +labels: [bug, need repro] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a bug report. It helps make Bun better. + + If you need help or support using Bun, and are not reporting a bug, please + join our [Discord](https://discord.gg/CXdq2DP29u) server, where you can ask questions in the [`#help`](https://discord.gg/32EtH6p7HN) forum. + + Please try to include as much information as possible. + - type: input + attributes: + label: What version of Bun is running? + description: Copy the output of `bun -v` + - type: input + attributes: + label: What platform is your computer? + description: | + For MacOS and Linux: copy the output of `uname -mprsv` + For Windows: copy the output of `"$([Environment]::OSVersion | ForEach-Object VersionString) $(if ([Environment]::Is64BitOperatingSystem) { "x64" } else { "x86" })"` in the PowerShell console + - type: textarea + attributes: + label: What steps can reproduce the bug? + description: Enter the details about your bug. If possible, please provide a small code snippet that can reproduce the issue. + - type: textarea + attributes: + label: How often does it reproduce? Is there a required condition? + - type: textarea + attributes: + label: What is the expected behavior? + description: If possible, please provide text instead of a screenshot. + - type: textarea + attributes: + label: What do you see instead? + description: If possible, please provide text instead of a screenshot. + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Is there anything else you think we should know? diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml deleted file mode 100644 index 1b68f6049..000000000 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: 🚀 Feature request -description: Suggest an idea for this project -labels: [enhancement] -body: - - type: markdown - attributes: - value: | - Thank you for suggesting an idea to make bun better. - - Please fill in as much of the following form as you're able. - - For more information on development, please reach out to our [discord server](https://bun.sh/discord). - - type: textarea - attributes: - label: What is the problem this feature will solve? - validations: - required: true - - type: textarea - attributes: - label: What is the feature you are proposing to solve the problem? - validations: - required: true - - type: textarea - attributes: - label: What alternatives have you considered? diff --git a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.yml b/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.yml deleted file mode 100644 index b0c3a3ffb..000000000 --- a/.github/ISSUE_TEMPLATE/3-api-ref-docs-problem.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: 📗 Open an issue regarding the bun docs -description: Let us know about any problematic documentations -labels: [documentation] -body: - - type: markdown - attributes: - value: | - Thank you for wanting to make bun better! - - Please fill in as much of the following form as you're able. - - type: input - attributes: - label: Affected URL(s) - - type: textarea - attributes: - label: Description of the problem - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/3-feature-request.yml b/.github/ISSUE_TEMPLATE/3-feature-request.yml new file mode 100644 index 000000000..0fcf6e83b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-feature-request.yml @@ -0,0 +1,24 @@ +name: 🚀 Feature Request +description: Suggest an idea, feature, or enhancement +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thank you for submitting an idea. It helps make Bun better. + + If you want to discuss Bun, or learn how others are using Bun, please + join our [Discord](https://discord.gg/CXdq2DP29u) server, where you can share in the [`#feedback-ideas`](https://discord.gg/unwUnHBNqy) channel. + - type: textarea + attributes: + label: What is the problem this feature would solve? + validations: + required: true + - type: textarea + attributes: + label: What is the feature you are proposing to solve the problem? + validations: + required: true + - type: textarea + attributes: + label: What alternatives have you considered? diff --git a/.github/ISSUE_TEMPLATE/4-docs-problem.yml b/.github/ISSUE_TEMPLATE/4-docs-problem.yml new file mode 100644 index 000000000..00f2f5939 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-docs-problem.yml @@ -0,0 +1,31 @@ +name: 📗 Documentation Request +description: Tell us if there is missing or incorrect documentation +labels: [documentation] +body: + - type: markdown + attributes: + value: | + Thank you for submitting a documentation request. It helps make Bun better. + + We are working on moving documentation from the [README](https://github.com/oven-sh/bun#table-of-contents) to a documentation website. Please report as many issues or missing content requests as you can so we can incoperate that in the new documentation. + - type: dropdown + attributes: + label: What is the type of issue? + multiple: true + options: + - Documentation is missing + - Documentation is incorrect + - Documentation is confusing + - Example code is not working + - Something else + validations: + required: true + - type: textarea + attributes: + label: What is the issue? + validations: + required: true + - type: textarea + attributes: + label: Where did you find it? + description: If possible, please provide the URL(s) where you found this issue.
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8d28621a8..1018bf5fd 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - - name: Discord server + - name: 💬 Ask a Question url: https://discord.com/invite/CXdq2DP29u - about: Please visit our Discord server for questions and support requests. + about: Join our Discord server for questions, support requests, or just to chat. |