Skip to content

Commit 3e32163

Browse files
authored
Direct issues to templates instead of GitHub Discussions (#8685)
## Rationale for this change We want to move away from discussions in general because they are not great to work with and everyone is more familiar with issues. ## What changes are included in this PR? Remove the Discussions redirect from the issue chooser and add Feature Request and Question issue forms in its place. Update CONTRIBUTING.md and the docs to point at issues (or Slack) rather than Discussions, and fix bug_report.yml to apply the existing "bug" label instead of the nonexistent "needs-triage". ## What APIs are changed? Are there any user-facing changes? N/A Signed-off-by: Connor Tsui <[email protected]>
1 parent b9779d6 commit 3e32163

8 files changed

Lines changed: 70 additions & 15 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Bug Report
22
description: Report something that isn't working correctly
3-
labels: ["needs-triage"]
3+
labels: ["bug"]
44
body:
55
- type: markdown
66
attributes:

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: Features, Questions
4-
url: https://github.com/vortex-data/vortex/discussions/new/choose
5-
about: Our preferred starting point if you have any questions or suggestions about configuration, features or behavior.
3+
- name: Community Slack
4+
url: https://vortex.dev/slack
5+
about: Chat with the community for quick questions and discussion.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ["feature"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem or motivation
9+
description: What are you trying to do that Vortex doesn't support today?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposed solution
17+
description: What would you like to see happen?
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: additional
23+
attributes:
24+
label: Additional context
25+
description: Alternatives considered, links, or anything else helpful
26+
validations:
27+
required: false
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Question
2+
description: Ask a question about using or configuring Vortex
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please check the [documentation](https://docs.vortex.dev) first. For quick
9+
back-and-forth, try the [Vortex Slack channel](https://vortex.dev/slack).
10+
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: What's your question?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: context
20+
attributes:
21+
label: Context
22+
description: What you've tried, relevant code, or your environment
23+
validations:
24+
required: false

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,13 @@ At the time of writing, the following individuals serve as Committers & Maintain
7575

7676
Our CI process enforces an extensive set of linter (e.g., `clippy`) rules, as well as language-specific formatters (e.g., `cargo fmt`). Beyond that, we document additional style guidelines in [STYLE.md](STYLE.md).
7777

78-
## Reporting Issues
78+
## Issues and Questions
7979

80-
Bugs should be filed as [GitHub Issues](https://github.com/vortex-data/vortex/issues). Open-ended
81-
questions and feature requests should be filed as
82-
[GitHub Discussions](https://github.com/vortex-data/vortex/discussions).
80+
Bugs, feature requests, and questions should all be filed as
81+
[GitHub Issues](https://github.com/vortex-data/vortex/issues/new/choose). We strongly prefer that
82+
you use one of the provided issue templates rather than opening a blank issue; templates make sure
83+
we get the information needed to act on your report. For quick questions, the
84+
[Vortex Slack channel](https://vortex.dev/slack) is also a good option.
8385

8486
## Developer Certificate of Origin (DCO)
8587

‎docs/developer-guide/embedding/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:::{warning}
44
This section is under construction. For guidance on embedding Vortex, please join the
55
[Vortex Slack channel](https://vortex.dev/slack)
6-
or start a [GitHub Discussion](https://github.com/vortex-data/vortex/discussions).
6+
or open a [GitHub Issue](https://github.com/vortex-data/vortex/issues/new/choose).
77
:::
88

99
Vortex can be embedded into applications and services via its C FFI, C++ wrapper, or the Scan API.

‎docs/developer-guide/extending/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:::{warning}
44
This section is under construction. For guidance on extending Vortex, please join the
55
[Vortex Slack channel](https://vortex.dev/slack)
6-
or start a [GitHub Discussion](https://github.com/vortex-data/vortex/discussions).
6+
or open a [GitHub Issue](https://github.com/vortex-data/vortex/issues/new/choose).
77
:::
88

99
Vortex is designed to be extended with custom types, encodings, layouts, and compute functions.

‎docs/project/contributing.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ The full contributing guide lives in the repository:
77

88
Below is a brief summary.
99

10-
## Reporting Issues
10+
## Issues and Questions
1111

12-
Bugs should be filed as [GitHub Issues](https://github.com/vortex-data/vortex/issues). Open-ended
13-
questions and feature requests should be filed as
14-
[GitHub Discussions](https://github.com/vortex-data/vortex/discussions).
12+
Bugs, feature requests, and questions should all be filed as
13+
[GitHub Issues](https://github.com/vortex-data/vortex/issues/new/choose). We strongly prefer that
14+
you use one of the provided issue templates rather than opening a blank issue; templates make sure
15+
we get the information needed to act on your report. For quick questions, the
16+
[Vortex Slack channel](https://vortex.dev/slack) is also a good option.
1517

1618
## Code Contributions
1719

18-
1. Start a discussion on GitHub (unless the change is trivial).
20+
1. Start a discussion by creating or commenting on a GitHub Issue (unless the change is trivial).
1921
2. Implement the change, including tests for new functionality or bug fixes.
2022
3. Open a pull request — ensure CI passes and that you sign off your commits (see below).
2123
CI requires approval from a committer for first-time contributors.

0 commit comments

Comments
 (0)