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: update issue templates with typescript codesandbox links #6480

Merged
merged 1 commit into from
Dec 8, 2023

Conversation

robinzigmond
Copy link
Contributor

The bug report and feature request templates contain links to our JS CSB template, but not to the TS one. We should provide this so it is easier for consumers to use Typescript in a codesandbox demonstrating their issue, if they wish to.

Proposed behaviour

Bug report/feature request templates should contain links to both JS and TS codesandbox templates.

Current behaviour

Only the JS one is linked to at the moment.

Checklist

  • Commits follow our style guide
  • Related issues linked in commit messages if required
  • Screenshots are included in the PR if useful
  • All themes are supported if required
  • Unit tests added or updated if required
  • Cypress automation tests added or updated if required
  • Playwright automation tests added or updated if required
  • Storybook added or updated if required
  • Translations added or updated (including creating or amending translation keys table in storybook) if required
  • Typescript d.ts file added or updated if required
  • Related docs have been updated if required

QA

  • Tested in CodeSandbox/storybook
  • Add new Cypress test coverage if required
  • Carbon implementation matches Design System/designs
  • UI Tests GitHub check reviewed if required

Additional context

Testing instructions

The following CodeSandbox is an example of the broken behaviour.
You can see the new behaviour by looking at the version in the comment by codesandbox[bot].

Copy link

codesandbox-ci bot commented Dec 8, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 34ae5b0:

Sandbox Source
carbon-quickstart Configuration
carbon-quickstart-typescript Configuration
carbon-quickstart PR

edleeks87
edleeks87 previously approved these changes Dec 8, 2023
@@ -17,7 +17,8 @@ body:
label: Desired behaviour
description: |
Please give a clear and concise description of the desired behaviour.
If applicable, add screenshots or screen recording of a [CodeSandbox](https://codesandbox.io/s/carbon-quickstart-j5pb2) to help explain the request. You can paste these directly into GitHub.
If applicable, add screenshots or screen recording of a CodeSandbox to help explain the request. You can paste these directly into GitHub.
We provide Codesandbox templates with Carbon and dependencies pre-loaded, using either , using either [Typescript](https://codesandbox.io/p/sandbox/carbon-quickstart-typescript-6sjfuz) or [Javascript](https://codesandbox.io/p/sandbox/carbon-quickstart-j5pb2).
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: think you have a typo here :)

Suggested change
We provide Codesandbox templates with Carbon and dependencies pre-loaded, using either , using either [Typescript](https://codesandbox.io/p/sandbox/carbon-quickstart-typescript-6sjfuz) or [Javascript](https://codesandbox.io/p/sandbox/carbon-quickstart-j5pb2).
We provide Codesandbox templates with Carbon and dependencies pre-loaded, using either [Typescript](https://codesandbox.io/p/sandbox/carbon-quickstart-typescript-6sjfuz) or [Javascript](https://codesandbox.io/p/sandbox/carbon-quickstart-j5pb2).

The bug report and feature request templates contain links to our JS CSB template, but not to the TS
one. We should provide this so it is easier for consumers to use Typescript in a codesandbox
demonstrating their issue, if they wish to.
@Parsium Parsium marked this pull request as ready for review December 8, 2023 16:30
@robinzigmond robinzigmond marked this pull request as ready for review December 8, 2023 16:30
@Parsium Parsium requested a review from a team as a code owner December 8, 2023 16:30
@robinzigmond robinzigmond requested a review from a team as a code owner December 8, 2023 16:30
@robinzigmond robinzigmond merged commit 287bc02 into master Dec 8, 2023
25 checks passed
@robinzigmond robinzigmond deleted the issue-template-update-csb branch December 8, 2023 16:45
@carbonci
Copy link
Collaborator

🎉 This PR is included in version 124.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

4 participants