Skip to content

fix(dev): Clarify issue template framework field #5480

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 2 commits into from
Jul 28, 2022

Conversation

lobsterkatie
Copy link
Member

In our bug template, we ask users for their SDK version and, if they're using a framework SDK (react, etc), the version of the framework. Users often misunderstand, however, and just provide the SDK version twice. This aims to clarify the distinction, by making three changes:

  • Adding clarifying language to the Framework Version field description.
  • Changing the placeholder example for the field to include the name of the framework, and a recent IRL version.
  • Changing the placeholder example for the SDK field to be the current version, to further emphasize which one is which.

It also fixes two schema errors highlighted by the linter.

@lobsterkatie lobsterkatie force-pushed the kmclb-clarify-issue-template-framework-field branch from 7294b4a to 83fbd51 Compare July 28, 2022 13:52
@lobsterkatie lobsterkatie merged commit 7d44301 into master Jul 28, 2022
@lobsterkatie lobsterkatie deleted the kmclb-clarify-issue-template-framework-field branch July 28, 2022 14:16
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.

2 participants