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

YAML Issue templates #144

Merged
merged 9 commits into from
Nov 11, 2024
Merged

YAML Issue templates #144

merged 9 commits into from
Nov 11, 2024

Conversation

CharlesDuboisSAP
Copy link
Contributor

@CharlesDuboisSAP CharlesDuboisSAP commented Nov 7, 2024

Context

AI/ai-sdk-java-backlog#91.

Aligned Java with Javascript style of issue templates

Feature scope:

  • Bug Report
  • Feature Request
  • Question

@CharlesDuboisSAP CharlesDuboisSAP self-assigned this Nov 7, 2024
@CharlesDuboisSAP CharlesDuboisSAP added the please-review Request to review a pull-request label Nov 7, 2024
@CharlesDuboisSAP CharlesDuboisSAP changed the title Issue template YAML Issue templates Nov 7, 2024
label: "Propose a Solution"
description: "A clear and concise description of what you want to happen."
validations:
required: true
Copy link
Contributor

Choose a reason for hiding this comment

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

(Comment)

Nice, solution proposal is required. I like

Comment on lines +9 to +11
This repository is for Java related issues only. Please open [JavaScript / TypeScript issues here](/~https://github.com/SAP/ai-sdk-js/issues/new/choose)
For any issue with the AI Core client, use the [Slack Support Channel for AI Core](https://sap-ml.slack.com/archives/C01DZC6EGB0) then simply type `/support-request`
**Missing information may result in delayed response**
Copy link
Contributor

Choose a reason for hiding this comment

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

(Minor)

I don't think we can link internal support channels from public resources.

Suggested change
This repository is for Java related issues only. Please open [JavaScript / TypeScript issues here](/~https://github.com/SAP/ai-sdk-js/issues/new/choose)
For any issue with the AI Core client, use the [Slack Support Channel for AI Core](https://sap-ml.slack.com/archives/C01DZC6EGB0) then simply type `/support-request`
**Missing information may result in delayed response**
This repository is for Java related issues only. Please open [JavaScript / TypeScript issues here](/~https://github.com/SAP/ai-sdk-js/issues/new/choose)
**Missing information may result in delayed response**

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It stays, this is the only sentence I wanted to put in the template

Comment on lines +35 to +38
- type: textarea
attributes:
label: "Screenshots"
description: "Add screenshots to help explain your problem."
Copy link
Contributor

Choose a reason for hiding this comment

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

(Question)

Does JS also have this field? I like it. But it may be unexpected for the author to "add screenshots" in a text field.

Copy link
Contributor Author

@CharlesDuboisSAP CharlesDuboisSAP Nov 8, 2024

Choose a reason for hiding this comment

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

You can upload pictures, it looks the same as the window in which we type comments.
I can remove it since screenshots can be uploaded in any field

Copy link
Contributor

@newtork newtork left a comment

Choose a reason for hiding this comment

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

Minor comments. I'm not sure whether these aren't too many fields.
On the other hand, we want to make sure to get high quality issues.
Time will tell, we might change the set of input fields in the future.

Co-authored-by: Alexander Dümont <22489773+newtork@users.noreply.github.com>
@CharlesDuboisSAP CharlesDuboisSAP enabled auto-merge (squash) November 8, 2024 14:27
@CharlesDuboisSAP CharlesDuboisSAP merged commit 81e7996 into main Nov 11, 2024
4 checks passed
@CharlesDuboisSAP CharlesDuboisSAP deleted the issue-template branch November 11, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please-review Request to review a pull-request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants