From c143ecf517facce853acb2d878285f2603ae0165 Mon Sep 17 00:00:00 2001 From: Mohab Sameh <37941642+mohab-sameh@users.noreply.github.com> Date: Tue, 31 Dec 2024 20:44:26 +0200 Subject: [PATCH] chore(repo): Update issue templates (#1435) --- .../ISSUE_TEMPLATE/report-faulty-codemod.md | 56 ++----------------- .github/ISSUE_TEMPLATE/request-codemod.md | 26 --------- 2 files changed, 6 insertions(+), 76 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/request-codemod.md diff --git a/.github/ISSUE_TEMPLATE/report-faulty-codemod.md b/.github/ISSUE_TEMPLATE/report-faulty-codemod.md index 8a3bfb68a..2496c7537 100644 --- a/.github/ISSUE_TEMPLATE/report-faulty-codemod.md +++ b/.github/ISSUE_TEMPLATE/report-faulty-codemod.md @@ -1,56 +1,12 @@ --- name: Faulty codemod -about: Report issues with an existing codemod. -title: "[codemod][FP/FN] " -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). diff --git a/.github/ISSUE_TEMPLATE/request-codemod.md b/.github/ISSUE_TEMPLATE/request-codemod.md deleted file mode 100644 index c317e8a05..000000000 --- a/.github/ISSUE_TEMPLATE/request-codemod.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: New codemod -about: Request a new codemod from the community. -title: "[codemod][new] - migration to " -labels: codemod-request -assignees: '' - ---- - -### Migration details -[Link to upgrade guide] - -- [ ] codemod-name1 - [[Codemod Studio Link](https://go.codemod.com/sme-input)] -- [ ] codemod-name2 - [[Codemod Studio Link](https://go.codemod.com/sme-input)] -- [ ] codemod-name3 - [[Codemod Studio Link](https://go.codemod.com/sme-input)] - - - ----- -To contributors working on this task: - -- [ ] **Framework Expert**: For each codemod use case in this migration, provide the Codemod Studio link ([example](https://go.codemod.com/sme-input)) with detailed specifications. Include before/after pairs, transformation logic in comments, and edge cases. Even if the transformation is tricky, provide instructions on detecting the patterns. This helps estimate the effort needed and guides developers to the areas requiring manual changes. - -- [ ] **Codemod Creator**: [Build](https://go.codemod.com/build-codemod-docs) and [publish](https://go.codemod.com/codemod-publish-doc) quality codemods that handle most edge cases. False negatives are acceptable, but there should be no false positives. Even if the transformation is tricky, build a codemod that can detect and add comments to guide developers to the areas needing manual changes. - -- Questions? -> [Community](https://go.codemod.com/community)