docs: add feature request + improvement issue templates, auto-assign new issues (#21)
- Add 2-feature_request.md and 3-improvement.md templates (chooser now lists Bug report, Feature request, Improvement in order) - Improve bug report template: cross-template pointer, Linux log hint, Related issues/PRs section, demo-DB reproduction hint - Auto-assign every newly opened issue to the repo owner: assignees in template front matter + a workflows/auto-assign.yml (covers issues opened without a template) - Add ISSUE_TEMPLATE/config.yml with Roadmap/README contact links - Update README Contributing section
This commit is contained in:
@@ -3,12 +3,15 @@ name: Bug report
|
||||
about: Report a bug or unexpected behavior in Gridline so we can fix it
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
assignees: ''
|
||||
assignees: ['AdrianBonpin']
|
||||
---
|
||||
|
||||
<!--
|
||||
Thank you for reporting a bug! A complete report is the fastest way to get it fixed.
|
||||
Please fill in every section you can — the environment table alone often closes issues.
|
||||
|
||||
Is this a request for something new instead? Use the
|
||||
Feature request or Improvement templates — those get triaged faster.
|
||||
-->
|
||||
|
||||
## Before you submit
|
||||
@@ -58,7 +61,9 @@ assignees: ''
|
||||
|
||||
<!--
|
||||
Paste the error text, console output, or a crash report here.
|
||||
On macOS: Console.app → Gridline. On Windows: Event Viewer → Application.
|
||||
- macOS: Console.app → Gridline
|
||||
- Windows: Event Viewer → Application
|
||||
- Linux: run Gridline from a terminal and capture stdout/stderr (or check the app-data dir, e.g. ~/.local/share/…)
|
||||
Remove anything that looks like a host/user/password/token before pasting.
|
||||
-->
|
||||
|
||||
@@ -76,6 +81,10 @@ assignees: ''
|
||||
|
||||
<!-- Anything that gets you unstuck today (e.g. "works when I connect without SSH", "restarting the app fixes it"). Even a partial workaround helps others. -->
|
||||
|
||||
## Related issues / PRs
|
||||
|
||||
<!-- Links to related issues, PRs, or roadmap items. -->
|
||||
|
||||
## Additional context
|
||||
|
||||
<!-- Anything else: does it reproduce with a fresh connection or only one specific database? Did it work in an earlier version? Frequency (always / sometimes)? -->
|
||||
<!-- Anything else: does it reproduce with a fresh connection or only one specific database? Did it work in an earlier version? Frequency (always / sometimes)? Does it happen on the demo SQLite database? -->
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest a new feature or capability for Gridline
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
assignees: ['AdrianBonpin']
|
||||
---
|
||||
|
||||
<!--
|
||||
Thank you for suggesting a feature! 🎉
|
||||
Before you submit, check that it isn't already shipped or planned:
|
||||
- README feature list: https://github.com/AdrianBonpin/gridline#features
|
||||
- Roadmap: https://github.com/AdrianBonpin/gridline/blob/prod/ROADMAP.md
|
||||
-->
|
||||
|
||||
## Before you submit
|
||||
|
||||
- [ ] I searched [existing issues](https://github.com/AdrianBonpin/gridline/issues?q=is%3Aissue) and this isn't a duplicate
|
||||
- [ ] I checked the [Roadmap](https://github.com/AdrianBonpin/gridline/blob/prod/ROADMAP.md) — it isn't already planned
|
||||
- [ ] I checked the [README feature list](https://github.com/AdrianBonpin/gridline#features) — it isn't already shipped
|
||||
- [ ] I will **not** paste secrets — redact any credentials as `<REDACTED>`
|
||||
|
||||
## Problem
|
||||
|
||||
<!-- What can't you do today? Describe the workflow that's blocked or painful. The problem matters more than the solution you have in mind. -->
|
||||
|
||||
## Proposed solution
|
||||
|
||||
<!-- How should it work? High-level description. Consider where it lives in the UI (home screen, DB viewer, object explorer, query editor, tools). Mockups welcome — see below. -->
|
||||
|
||||
## Example scenario
|
||||
|
||||
<!-- A concrete walkthrough: "I want to compare row counts across three production schemas, so I open … and …" -->
|
||||
|
||||
## Alternatives considered
|
||||
|
||||
<!-- What you do today instead: other tools, manual SQL, workarounds. This helps us judge how much it's really needed. -->
|
||||
|
||||
## Scope
|
||||
|
||||
<!-- Rough size so we can prioritize. -->
|
||||
|
||||
- [ ] Small — UI polish / single command
|
||||
- [ ] Medium — a new view or feature area
|
||||
- [ ] Large — new DB type, new driver, multi-week effort
|
||||
|
||||
## Mockups / screenshots
|
||||
|
||||
<!-- Drag & drop sketches or screenshots; ASCII art is fine. If referencing how another tool does it, name the tool (TablePlus, Beekeeper Studio, DB Pro, …). -->
|
||||
|
||||
## Related
|
||||
|
||||
<!-- Roadmap items, related issues/PRs, competitor references, docs links. -->
|
||||
|
||||
## Priority
|
||||
|
||||
<!-- Optional: how important is this to you? -->
|
||||
|
||||
- [ ] Nice to have
|
||||
- [ ] Important — would save me time every day
|
||||
- [ ] Critical — blocks my workflow without it
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: Improvement
|
||||
about: Suggest a refinement or UX polish for an existing Gridline feature
|
||||
title: "[Improvement]: "
|
||||
labels: ["enhancement"]
|
||||
assignees: ['AdrianBonpin']
|
||||
---
|
||||
|
||||
<!--
|
||||
For refinements to something that already exists — not brand-new features
|
||||
(use the Feature request template for those) and not bugs (use Bug report).
|
||||
Examples: a confusing label, a clunky interaction, a missing keyboard shortcut,
|
||||
faster scroll, better default, accessibility fix.
|
||||
-->
|
||||
|
||||
## Before you submit
|
||||
|
||||
- [ ] I searched [existing issues](https://github.com/AdrianBonpin/gridline/issues?q=is%3Aissue) and this isn't a duplicate
|
||||
- [ ] This targets an **existing** feature (not a new one)
|
||||
- [ ] I will **not** paste secrets — redact any credentials as `<REDACTED>`
|
||||
|
||||
## What's lacking today?
|
||||
|
||||
<!-- The pain point in the current behavior. Point at the exact screen/flow. -->
|
||||
|
||||
## Suggested change
|
||||
|
||||
<!-- The refinement. What should it look like / behave like? Specific beats vague. -->
|
||||
|
||||
## Why it matters
|
||||
|
||||
<!-- Who benefits and how (time saved, fewer misclicks, consistency, accessibility, …). -->
|
||||
|
||||
## Screenshots / recordings
|
||||
|
||||
<!-- Current behavior, plus any mock of the desired behavior. -->
|
||||
|
||||
## Related
|
||||
|
||||
<!-- Links to related issues/PRs. -->
|
||||
@@ -0,0 +1,10 @@
|
||||
# Template chooser settings — see
|
||||
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Gridline Roadmap
|
||||
url: https://github.com/AdrianBonpin/gridline/blob/prod/ROADMAP.md
|
||||
about: Check what's already planned before requesting a feature
|
||||
- name: README — feature list
|
||||
url: https://github.com/AdrianBonpin/gridline#features
|
||||
about: Confirm a feature isn't already shipped
|
||||
@@ -0,0 +1,25 @@
|
||||
name: Auto-assign new issues
|
||||
|
||||
# Assigns every newly opened issue to the repository owner so nothing
|
||||
# lands in the inbox untriaged. The `issues` event only fires in the base
|
||||
# repository (not forks) and this job never checks out code — it only
|
||||
# talks to the GitHub API, so there is no fork/pwn-request exposure.
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
auto-assign:
|
||||
name: Assign issue to repo owner
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Assign to ${{ github.repository_owner }}
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
ISSUE_URL: ${{ github.event.issue.html_url }}
|
||||
OWNER: ${{ github.repository_owner }}
|
||||
run: gh issue edit "$ISSUE_URL" --add-assignee "$OWNER"
|
||||
@@ -452,7 +452,7 @@ Highlights of what's next:
|
||||
|
||||
Contributions, bug reports, and feature ideas are welcome. Gridline is Apache 2.0-licensed and intentionally stays open — no paywalled tiers, no bundled proprietary services.
|
||||
|
||||
- Report a bug via the **[issue template](.github/ISSUE_TEMPLATE/bug_report.md)** — it walks you through environment details (OS, Gridline version, DB type/version, connection method) so we can reproduce issues quickly. Opening a [new issue](https://github.com/AdrianBonpin/gridline/issues/new) pre-fills the template automatically.
|
||||
- Open an issue via the **[template chooser](https://github.com/AdrianBonpin/gridline/issues/new)** — pick **Bug report** (with an environment table so we can reproduce issues quickly), **Feature request**, or **Improvement** (UX polish for existing features). New issues are auto-assigned to the maintainer.
|
||||
- Submit a pull request. Keep Tauri commands thin, type IPC boundaries explicitly, and follow the existing Rust/React conventions.
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user