Skip to content

Docs review: Twoslash Powered Bug Repros in Issues #39615

Closed
@orta

Description

@orta

Docs review

Code Sample Repros powered by twoslash in GH issues. RFC here.

Questions to answer

  • What does the new user flow like?
  • Are there missing types of bugs we'd like in it?
  • How do we recommend it?
  • Date: July 15th, 2020
  • Agenda
  1. Overview of workflow 10m
  2. Show examples in action 5min
  3. Disucssion 10min

Links

Examples:

Action Items

What does the new user flow like?

Considering three entry points:

  • creating an issue (mention it in the issue template)
  • clicking the info from the bot
  • seeing a list of 'wanting repro' bugs

Are there missing types of bugs we'd like in it?

  • the results of jump to definition
  • the results for rename of an identifier

These can have additional syntax similar to how // ^| was added for completions

How do we recommend it?

Gently, by the three ideas above and maybe by providing some incentives in the discord

TODO

  • Remove the new comment which happens when assertions change in nightly builds. Likely will end up as too much noise, and it's the number of these repros may be small enough to keep on top of.

  • Add a way for a bot to add / remove the label for "Has Repro" on the TS repo based on PR body / comments

  • Add a way for a user to ask for the repros on a PR to be built instantly @typescript-bot repro this

  • Ship it to Microsoft/TypeScript

  • Add an export to fourslash, or export to baselines feature in the bug workbench. To make it trivial to C&P and go in the compiler codebase.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Docs Meeting NotesWrite-ups on the meeting every two weeks on docs topics

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions