diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.yml b/.github/workflows/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..7a7499765 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,80 @@ +name: "🐛 Bug Report" +description: Report a bug for OpenStatus. +labels: + - "needs-triage" + - "bug" +body: + - type: markdown + attributes: + value: | + ## Welcome 👋🏻 + + Thank you for taking the time to report an issue with OpenStatus. Please fill out the information below to help us resolve your issue faster. If you have a question or need general help, please join our [Discord community](https://www.openstatus.dev/discord). + - type: checkboxes + attributes: + label: Preliminary Checks + description: Please make sure that you verify each checkbox and follow the instructions for them. + options: + - label: | + I have reviewed the documentation: https://docs.openstatus.dev/ + required: true + - label: | + I have searched for existing issues: https://github.com/openstatusHQ/openstatus/issues + required: true + - label: | + This issue is not a question, general help request, or anything other than a bug report directly related to OpenStatus. Please ask questions in our Discord community: https://www.openstatus.dev/discord + required: true + - type: input + id: reproduction-link + attributes: + label: Reproduction / Replay Link (Optional) + placeholder: "https://github.com/username/repository-name/" + description: | + Link to a minimal reproduction (GitHub repository, CodeSandbox, StackBlitz, etc.) or a [Replay recording](https://www.replay.io/). + + **Do not link to your actual project**, but provide a minimal reproduction in a fresh project. + + Instructions: + - [How to record a Replay](https://docs.replay.io/bug-reports/recording-a-replay) + validations: + required: false + - type: textarea + attributes: + label: Description + description: Describe the issue that you're seeing. + value: | + + + **Steps to reproduce:** + + 1. Step 1 + 2. Step 2 + + **Expected behavior:** + + + + **Actual behavior:** + + + validations: + required: true + - type: textarea + attributes: + label: Environment + render: Shell + description: Run "npx envinfo --system --browsers --binaries --npmPackages" in your project directory and paste the output here. + placeholder: | + You'll get an output similar to this: + + System: + OS: Operating System + CPU: CPU + Binaries: + Node: X + npm: X + Browsers: + Chrome: X + Edge: X + validations: + required: false diff --git a/.github/workflows/ISSUE_TEMPLATE/config.yml b/.github/workflows/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..531f29e32 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord community support + url: https://www.openstatus.dev/discord + about: Need any help? Found any bug? Please chat with us via Discord. diff --git a/.github/workflows/ISSUE_TEMPLATE/doc_report.yml b/.github/workflows/ISSUE_TEMPLATE/doc_report.yml new file mode 100644 index 000000000..ee91d4871 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/doc_report.yml @@ -0,0 +1,24 @@ +name: "📚 Documentation request" +description: Need to report a documentation issue? Please fill out the information below +title: '[docs]' +labels: ['documentation'] +body: + - type: dropdown + id: type-of-doc-issue + attributes: + label: Type of documentation issue + multiple: true + options: + - "Broken Link" + - "Incorrect Information" + - "Typo" + - "Missing Information" + - "Other" + validations: + required: true + - type: textarea + attributes: + label: Describe the problem and the proposed solution + description: Please describe the change & need of change in as much detail possible. + validations: + required: false \ No newline at end of file diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.yml b/.github/workflows/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..635fcbd27 --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,32 @@ +name: "💡 Feature Request" +description: Describe a new feature or capability you would like to see in OpenStatus' offering. +labels: + - "enhancement" +body: + - type: markdown + attributes: + value: | + ## Welcome 👋🏻 + + Thank you for taking the time to write up a feature request. Please fill out the information below to be able to help you faster. If you have a question or need general help, please join our [Discord community](https://www.openstatus.dev/discord). + - type: checkboxes + attributes: + label: Preliminary Checks + description: Please make sure that you verify each checkbox and follow the instructions for them. + options: + - label: | + I have reviewed https://docs.openstatus.dev/ for existing features that would solve my problem + required: true + - label: | + I have searched for existing feature requests: https://github.com/openstatusHQ/openstatus/issues + required: true + - label: | + This issue is not a question, general help request, or anything other than a feature request directly related to OpenStatus. Please ask questions in our Discord community: https://discord.com/invite/dHD4JtSfsn. + required: true + - type: textarea + attributes: + label: Description + description: Describe the feature or capability you would like to see in OpenStatus' offering. + placeholder: Make sure it's unique, describe your use case, and explain the problem and proposed solution. + validations: + required: true \ No newline at end of file diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md new file mode 100644 index 000000000..e7fb48a8d --- /dev/null +++ b/.github/workflows/pull_request_template.md @@ -0,0 +1,26 @@ +## Type of change + + + +- [ ] 🐛 Bug fix +- [ ] 🌟 New feature +- [ ] 🔨 Breaking change +- [ ] 📖 Refactoring / dependency upgrade / documentation + +## Description + + + +### A picture tells a thousand words (if any) + +### Before this PR + +{Please add a screenshot here} + +### After this PR + +{Please add a screenshot here} + +### Related Issue (optional) + + \ No newline at end of file