Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[FR]: Add new kurtosis feedback flags #219

Closed
leeederek opened this issue Mar 15, 2023 · 2 comments · Fixed by #287
Closed

[FR]: Add new kurtosis feedback flags #219

leeederek opened this issue Mar 15, 2023 · 2 comments · Fixed by #287
Assignees
@leoporoli
Labels
feature request

Comments

@leeederek
Copy link
Contributor

Background & current behavior

When I run: kurtosis feedback "my feedback" --github, I end up on the Github issues page where I then have to use the Github UI to select what kind of Issue to file (docs, feature request, or bug report).

More often than not, I already know what kind of Github issue I want to file. Being able to specify my preferred feedback route using a flag to pass into the kurtosis feedback command would make it easier and smoother for me to submit feedback to the Kurtosis team.

Desired behavior

I would like to see 3 new flags added to the kurtosis feedback --github command:

  1. When I run: kurtosis feedback "my feedback" --github --bug a Github link opens up to the Bug Report Github issue template with the "Description and steps to reproduce" section pre-populated with "my feedback" (example)
  2. When I run: kurtosis feedback "my feedback" --github --fr a Github link opens up to the Feature Request Github issue template with the "Background and current behavior" section pre-populated with "my feedback" (example).
  3. When I run: kurtosis feedback "my feedback" --github --docs a Github link opens up to the Docs Issue Github issue template with the "Description of the issue" section pre-populated with "my feedback" (example).

How important is this feature or improvement to you?

Painful, the lack of this feature makes using Kurtosis frictionful.
@mieubrisse
Copy link
Collaborator

mieubrisse commented Mar 15, 2023 •
edited
Loading

@leeederek very aligned; when building the quickstart I used --github a LOT. I actually didn't send any emails because I was afraid they would get lost in the shuffle.

Wdyt if:

  • github is the default action of kurtosis feedback
  • raw kurtosis feedback takes the user to the New Github Issue page
  • all the flags work as you describe
  • the same --fr/--bug/--docs command are used with the --email flag (but just to set the subject prefix)?

@leeederek leeederek mentioned this issue Mar 16, 2023
Closed
@leeederek
Copy link
Contributor Author

Hey @mieubrisse! Thanks for your feedback. I'm going to keep this Issue tightly scoped to the work required for adding new flags, and have created #226 to track the work required to swap the default operation in kurtosis feedback from Email to Github 👍🏻!

@leoporoli leoporoli self-assigned this Mar 16, 2023
@leoporoli leoporoli mentioned this issue Mar 21, 2023
Merged
@leeederek leeederek mentioned this issue Mar 22, 2023
Merged
@leoporoli leoporoli mentioned this issue Mar 22, 2023
Merged
leeederek added a commit that referenced this issue Mar 25, 2023
@leeederek
fix: reformat build prereqs in readme (#290)
c286151 
## Description:
Was setting up the pre-reqs to build Kurtosis locally to test a #219 but
noticed the formatting was off and hard to consume. This PR makes those
instructions easier to read and follow.

## Is this change user facing?
YES
<!-- If yes, please add the "user facing" label to the PR -->
<!-- If yes, don't forget to include docs changes where relevant -->

## References (if applicable):
<!-- Add relevant Github Issues, Discord threads, or other helpful
information. -->
leoporoli pushed a commit that referenced this issue Mar 27, 2023
@leeederek @leoporoli
fix: reformat build prereqs in readme (#290)
a856dd8 
## Description:
Was setting up the pre-reqs to build Kurtosis locally to test a #219 but
noticed the formatting was off and hard to consume. This PR makes those
instructions easier to read and follow.

## Is this change user facing?
YES
<!-- If yes, please add the "user facing" label to the PR -->
<!-- If yes, don't forget to include docs changes where relevant -->

## References (if applicable):
<!-- Add relevant Github Issues, Discord threads, or other helpful
information. -->
leoporoli added a commit that referenced this issue Mar 27, 2023
@leoporoli
feat: Added bug, feature and docs flags in the kurtosis feedback …
963e9dd 
…command (#287)

## Description:
- Adding `bug, fr and docs` kurtosis feedback flags
- GitHub is the default feedback destination now.
- Edited the kurtosis feedback command description text

## Is this change user-facing?
YES

## References (if applicable):
Fixes #219 & #226
leoporoli added a commit that referenced this issue Mar 27, 2023
@leoporoli
docs: upgraded kurtosis feedback command docs, added the `bug, fr a…
f0c8769 
…nd docs` flags (#292)

## Description:
Upgraded `kurtosis feedback` command docs, added the `bug, fr and docs`
flags

## Is this change user facing?
YES

## References (if applicable):
tickets: #226 and #219 

@leeederek you can review only this file:
docs/docs/reference/cli/feedback.md because [there is another PR for the
code](#287)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leoporoli leoporoli

Labels
feature request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Added bug, feature and docs flags in the kurtosis feedback command kurtosis-tech/kurtosis
3 participants
@mieubrisse @leoporoli @leeederek