Skip to content

Commit

Permalink
chore(repo): Update issue templates (#1435)
Browse files Browse the repository at this point in the history
  • Loading branch information
mohab-sameh authored Dec 31, 2024
1 parent bb843bd commit c143ecf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 76 deletions.
56 changes: 6 additions & 50 deletions .github/ISSUE_TEMPLATE/report-faulty-codemod.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,12 @@
---
name: Faulty codemod
about: Report issues with an existing codemod.
title: "[codemod][FP/FN] <codemod-name>"
labels: codemod-issue, studio
about: To report a faulty codemod, open an issue in the repository of the published
codemod in Codemod Registry.
title: Report faulty codemod
labels: codemod-issue
assignees: ''

---

### Faulty codemod

1. Mention the codemod name, e.g., `react/19/remove-forward-ref`
2. If available, link to the codemod source, e.g., [source](https://github.com/reactjs/react-codemod/tree/master/transforms)

### Sample code snippets

If the codemod source is available and supported in the studio, please share a link including the before/after code snippets. If not, provide them below, e.g.:

See this [Codemod Studio link](https://go.codemod.com/faulty-codemod-demo) for sample code snippets and a description of the issue.

#### Original

```ts
//insert your original code here
```

#### Expected

```ts
//insert the expected **correct** output here
```

#### Actual

```ts
//insert the actual **faulty** output here
```

### Estimated impact
Numbers about your specific codemod run:

- Total number of files/instances transformed: X
- Number of files/instances missed by the codemod (FN): X
- Number of files/instances mistakenly transformed (FP): X

Anything else that helps the community prioritize, e.g.:
- I still need this fix for my current or upcoming migration.
OR
- I manually fixed my issue, but I'm reporting this for other community members.

### Logs:

// Please insert the contents of a log file generated by the codemod run here.

### Additional context
Add any other context about the problem here. This might include the target project, an explanation of the faulty output related to business logic, relevant links, etc.
> [!WARNING]
> Please do not report faulty codemods in this repository. Codemod packages are owned and maintained by their original authors. To report a faulty codemod, raise an issue in the repository specified in the published codemod on [Codemod Registry](https://codemod.com/registry).
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/request-codemod.md

This file was deleted.

0 comments on commit c143ecf

Please sign in to comment.