Skip to content

How to Report an Issue

Jump to bottom
Jed Mao edited this page May 22, 2019 · 2 revisions

How to file a bug

  1. Go to our issue tracker on GitHub
  2. Search for existing issues using the search field at the top of the page
  3. File a new issue including the info listed below
  4. Thanks a ton for helping make generator-tsx higher quality!

When filing a new bug, please include:

  • Descriptive title - use keywords so others can find your bug (avoiding duplicates)
  • Steps to trigger the problem that are specific, and repeatable
  • What happens when you follow the steps, and what you expected to happen instead.
    Include the exact text of any error messages if applicable (or upload screenshots).
  • generator-tsx version (or if you're pulling directly from Git, your current commit SHA - use git rev-parse HEAD)
  • Did this work in a previous version? If so, also provide the version that it worked in.
  • OS version
  • Node.js version
  • npm version

Requesting a feature

Please first check the issue tracker on GitHub to see if it's already there. You can vote on features to help us prioritize them.

Feel free to file new feature requests as an issue on GitHub, just like a bug.

What happens after a bug is filed?

Bug lifecycle

  1. New bug is filed; awaiting review
  2. Triaged in bug review
  3. Developer begins working on it
  4. Developer opens pull request with a fix
  5. Pull request is merged

Bug review

We review all new issues on a regular basis. Typically, we may ping the filer for clarification if needed.

Depending on priority, milestone, and other workload, a developer may or may not begin working on the bug soon.

Some bugs may be closed without fixing - see "Hey! My bug wasn't fixed!" below.

Hey! My bug wasn't fixed!

Yeah, what's up with that? There are a number of reasons an issue might get closed without being fixed:

  • Duplicate - There's already a bug for this.
  • Unable to reproduce - We're unable to reproduce the result described in the bug report. If you're still seeing it, please reply with more detailed steps to trigger the bug.
  • Out of scope idea - This change probably doesn't belong in generator-tsx.
  • Not a bug / fact of life - This is the intended behavior. If it feels wrong, we should discuss how to improve the usability of the feature.

If you disagree with a bug being closed, feel free to post a comment asking for clarification or re-evaluation. The more new/updated info you can provide, the better.

Can I help fix a bug?

Yes please! But first...

Want to contribute to this Wiki?

Fork it and send a pull request.

Clone this wiki locally