-
Notifications
You must be signed in to change notification settings - Fork 8
docs: add issue templates for bug reports and feature requests #1045
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| name: Bug report | ||
| description: Report a problem with the Kosli CLI | ||
| title: "bug: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: Thanks for taking the time to file a bug report! | ||
| - type: checkboxes | ||
| id: preflight | ||
| attributes: | ||
| label: Preflight | ||
| options: | ||
| - label: I searched existing issues and didn't find a duplicate. | ||
| required: true | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: A clear description of the bug, including what you expected to happen instead. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduce | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: The exact `kosli` command(s) you ran and any relevant flags or config. Redact any tokens or secrets. | ||
| placeholder: | | ||
| 1. Run `kosli ...` | ||
| 2. ... | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: CLI version | ||
| description: Output of `kosli version`. | ||
| placeholder: v2.x.y | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: OS, CI system, and how you installed the CLI (script, brew, Docker, etc.). | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Logs / output | ||
| description: Relevant output, ideally with `--debug`. This will be rendered as code, so no need for backticks. Redact any tokens or secrets. | ||
| render: shell | ||
| validations: | ||
| required: false | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: true | ||
|
mbevc1 marked this conversation as resolved.
|
||
| contact_links: | ||
| - name: Kosli documentation | ||
| url: https://docs.kosli.com | ||
| about: Guides and reference for the Kosli CLI and platform. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: Feature request | ||
| description: Suggest an idea or enhancement for the Kosli CLI | ||
| title: "feat: " | ||
| labels: ["enhancement"] | ||
| body: | ||
|
mbevc1 marked this conversation as resolved.
|
||
| - type: markdown | ||
| attributes: | ||
| value: Thanks for taking the time to suggest an improvement! | ||
| - type: checkboxes | ||
| id: preflight | ||
| attributes: | ||
| label: Preflight | ||
| options: | ||
| - label: I searched existing issues and didn't find a duplicate. | ||
| required: true | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: What problem are you trying to solve? | ||
| description: Describe the use case or pain point. What are you trying to achieve? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposed solution | ||
| description: What would you like the CLI to do? Include example commands or flags if you have them in mind. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| description: Any workarounds or other approaches you've thought about. | ||
| validations: | ||
| required: false | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.