From c270ac2d47b9bc3f59c4f69e533ec7b318b9f744 Mon Sep 17 00:00:00 2001 From: sxyazi Date: Thu, 27 Jun 2024 10:17:21 +0800 Subject: [PATCH] feat: add issue templates and workflows --- .github/ISSUE_TEMPLATE/bug.yml | 78 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature.yml | 31 ++++++++++++ .github/workflows/lock.yml | 31 ++++++++++++ .github/workflows/no-response.yml | 19 ++++++++ 5 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/workflows/lock.yml create mode 100644 .github/workflows/no-response.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..b81e00f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: Create a report to help us improve +labels: [bug] +assignees: [] +body: + - type: dropdown + id: os + attributes: + label: What system are you running Yazi on? + options: + - Linux X11 + - Linux Wayland + - macOS + - Windows + - Windows WSL + validations: + required: true + - type: checkboxes + attributes: + label: You are using the latest commit of Yazi right? + description: The plugin system is still in the early stage, plugins in this repository are only guaranteed to be compatible with the latest nightly builds of Yazi. Before filing an issue, please ensure both your plugin and Yazi are up to date. + options: + - label: Yes, I built Yazi from the latest code + required: true + - type: textarea + id: debug + attributes: + label: "`yazi --debug` output" + description: Please do a `yazi --debug` and paste the output here. + value: | +
+ + + ```sh + + ``` + +
+ validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is + placeholder: Tell us what happened + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen + validations: + required: true + - type: textarea + id: to_repro + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + Please include as much information as possible that can help to reproduce and understand the issue. + validations: + required: true + - type: textarea + id: config + attributes: + label: Configuration + description: | + Please include the relevant section(s) of your `yazi.toml`, `keymap.toml`, or `theme.toml` configuration file. + You can enter "no config" if the issue happens without you having made a config file. + - type: textarea + id: other + attributes: + label: Anything else? + description: | + Add any other context about the problem here. You can attach screenshots by clicking + this area to highlight it and then drag the files in. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f8c4807 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord server / Telegram group + url: https://github.com/sxyazi/yazi#discussion + about: If you'd prefer more realtime conversation with the community diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..c9e9fb8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest an idea for this project +labels: [feature] +assignees: [] +body: + - type: textarea + id: problem + attributes: + label: Please describe the problem you're trying to solve + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: checkboxes + id: contribute + attributes: + label: Would you be willing to contribute this feature? + description: The feature has a much higher chance of completion if you are willing to get involved! + options: + - label: Yes, I'll give it a shot + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml new file mode 100644 index 0000000..261c898 --- /dev/null +++ b/.github/workflows/lock.yml @@ -0,0 +1,31 @@ +name: Lock Threads + +on: + schedule: + - cron: "5 3 * * *" + workflow_dispatch: + +concurrency: + group: lock + +jobs: + lock: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + discussions: write + steps: + - uses: dessant/lock-threads@v5 + with: + issue-inactive-days: "30" + issue-comment: > + I'm going to lock this issue because it has been closed for _30 days_. ⏳ + + This helps our maintainers find and focus on the active issues. + If you have found a problem that seems similar to this, please open a new + issue and complete the issue template so we can capture all the details + necessary to investigate further. + pr-inactive-days: "30" + discussion-inactive-days: "30" + process-only: "issues,prs,discussions" diff --git a/.github/workflows/no-response.yml b/.github/workflows/no-response.yml new file mode 100644 index 0000000..51d2cad --- /dev/null +++ b/.github/workflows/no-response.yml @@ -0,0 +1,19 @@ +name: No Response + +on: + issue_comment: + types: [created] + schedule: + - cron: "10 * * * *" + +jobs: + no-response: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - uses: lee-dohm/no-response@v0.5.0 + with: + token: ${{ github.token }} + daysUntilClose: 7 + responseRequiredLabel: waiting on op