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.

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

chore: issue templates #716

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

dextrot
Copy link
Contributor

@dextrot dextrot commented Feb 27, 2024

This PR fixes #641

  • Adds issue templates for: Bug report, feature request and the config file for the templates.
    Screenshot from 2024-02-28 01-44-18

Signed-off-by: dextrot <131444479+dextrot@users.noreply.github.com>
Signed-off-by: dextrot <131444479+dextrot@users.noreply.github.com>
@dextrot
Copy link
Contributor Author

dextrot commented Feb 27, 2024

added the issue templates here @FeynmanZhou @shizhMSFT

Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.92%. Comparing base (be59736) to head (0d3a2b7).
Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #716   +/-   ##
=======================================
  Coverage   75.92%   75.92%           
=======================================
  Files          59       59           
  Lines        5873     5873           
=======================================
  Hits         4459     4459           
  Misses       1037     1037           
  Partials      377      377           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
@shizhMSFT shizhMSFT changed the title Issue templates chore: issue templates Mar 7, 2024
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dextrot Issue templates for oras-go should not be directly copied from the oras repo since the SDK is very different from a CLI.

Consider adapting issue templates from notation-go, which is also a golang library.

required: true
attributes:
label: What happened in your environment?
description: "Please also attach logs here using `--debug` flag."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since oras-go is a library, there is no --debug flag.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shizhMSFT can we put the description like : description: "Please also attach logs here ." ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we put the description like : description: "Please also attach logs here ." ?

This sounds good to me.

Comment on lines 46 to 47
label: What is the version of your ORAS CLI?
description: "You can use the command `oras version` to get it."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, it is oras-go library, not a CLI. There is no oras version command for it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also applies to feature-request.yaml.

dextrot and others added 3 commits March 11, 2024 14:36
Co-authored-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
Co-authored-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
Co-authored-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dextrot . Please do not replicate the ORAS issue template here as they have different functionalities. PTAL at my comments above

Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
Signed-off-by: SKM <131444479+dextrot@users.noreply.github.com>
@Wwwsylvia
Copy link
Member

@dextrot Thanks for the contribution! Could you address the remaining comments and rebase?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add issue template for oras-go
4 participants