diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d3577d8..1de4ace 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,46 +1,39 @@ --- -name: Bug report +name: 🐛 Bug report about: Open a bug report -title: "[BUG]" +title: "[bug] " labels: bug -assignees: tiagorangel1 +assignees: tiagozip --- -**Describe the bug** -A clear and concise description of what the bug is. + -**Affects:** -- [] Standalone mode -- [] Widget -- [] Server -- [] WASM -- [] Solver -- [] Solver CLI +**bug description:** +a clear and concise description of what the bug is and how it happened. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**affects:** +- [] standalone +- [] widget (ui) +- [] widget (wasm solver) +- [] js server +- [] js solver -**Expected behavior** -A clear and concise description of what you expected to happen. +**to reproduce:** +steps to reproduce the behavior. include as much information as possible, but make sure to redact secrets. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**expected behavior:** +a clear and concise description of what you expected to happen. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**screenshots:** +if applicable, add screenshots to help explain your problem. +please use code blocks instead of screenshots for pasting errors, logs and code. -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +**versions and environment:** +e.g. browser, os, device, etc -**Additional context** -Add any other context about the problem here. +**additional context:** +add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2af3f30..58121f3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -3,18 +3,18 @@ name: Feature request about: Suggest an idea for this project title: '' labels: '' -assignees: tiagorangel1 +assignees: tiagozip --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**what problem would this feature solve, if any?** +a clear and concise description of what the problem is -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**describe the solution you'd like** +a clear and concise description of what you want to happen. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**describe alternatives you've considered** +a clear and concise description of any alternative solutions or features you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. +**additional context:** +add any other context or screenshots about the feature request here. diff --git a/.github/workflows/auto-close-issues.yml b/.github/workflows/auto-close-issues.yml new file mode 100644 index 0000000..120351e --- /dev/null +++ b/.github/workflows/auto-close-issues.yml @@ -0,0 +1,37 @@ +name: Auto-close empty issues + +on: + issues: + types: [opened] + +permissions: + issues: write + +jobs: + close: + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v7 + with: + script: | + const title = context.payload.issue.title?.trim() + const body = context.payload.issue.body ?? "" + + const badTitle = title === "[BUG]" + const badBody = body.includes("A clear and concise description of what the bug is.") + + if (badTitle && badBody) { + await github.rest.issues.update({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.issue.number, + state: "closed" + }) + + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.issue.number, + body: "This issue has been automatically closed due to it being empty. If this isn't intentional, please re-open it with a proper title and body." + }) + } diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ab99185..1a98722 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -41,9 +41,9 @@ jobs: - name: Setup Pages uses: actions/configure-pages@v4 - name: Install dependencies - run: cd docs && bun install # or pnpm install / yarn install / bun install + run: cd docs && bun install - name: Build with VitePress - run: bun run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build + run: cd docs && bun run build - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: