diff --git a/.github/ISSUE_TEMPLATE/1_bug-report.md b/.github/ISSUE_TEMPLATE/1_bug-report.md deleted file mode 100644 index 62b3d08a2..000000000 --- a/.github/ISSUE_TEMPLATE/1_bug-report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[Bug] Title goes here." -labels: bug -assignees: '' - ---- - -**Describe the bug** -*A clear and concise description of what the bug is.* - - - - -**How to reproduce** -*Steps or a minimal working example to reproduce the behavior* - - - - -**Expected behavior** -*A clear and concise description of what you expected to happen.* - - - -**Logs/screenshots** -*If applicable, add logs/screenshots to help explain your problem.* - -**Environment** -- Transformers.js version: -- Browser (if applicable): -- Operating system (if applicable): -- Other: - - -**Additional context** -*Add any other context about the problem here.* - - diff --git a/.github/ISSUE_TEMPLATE/1_bug-report.yml b/.github/ISSUE_TEMPLATE/1_bug-report.yml new file mode 100644 index 000000000..70ceedd96 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug-report.yml @@ -0,0 +1,51 @@ +name: "🐛 Bug Report" +description: Submit a bug report to help us improve transformers.js +labels: [ "bug" ] +body: + - type: textarea + id: system-info + attributes: + label: System Info + description: Please share your system info with us. If you are using other JS libraries/frameworks (e.g., React or Next.js), please include their versions too. + placeholder: transformers.js version, browser (if applicable), operating system, Node.js version, bundlers, ... + validations: + required: true + + - type: checkboxes + id: environment + attributes: + label: Environment + description: "The environment I am running in:" + options: + - label: "Website/web-app" + - label: "Browser extension" + - label: "Server-side (e.g., Node.js, Deno, Bun)" + - label: "Desktop app (e.g., Electron)" + - label: "Other (e.g., VSCode extension)" + + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + description: A clear and concise description of the bug, as well as what you expected to happen. + + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Reproduction + description: | + Please provide a code sample that reproduces the problem you ran into. + If you have code snippets, error messages, stack traces please provide them here as well. + Important! Use [code tags](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) to correctly format your code. + + placeholder: | + Steps to reproduce the behavior: + + 1. + 2. + 3. + diff --git a/.github/ISSUE_TEMPLATE/2_feature-request.md b/.github/ISSUE_TEMPLATE/2_feature-request.md deleted file mode 100644 index 235519115..000000000 --- a/.github/ISSUE_TEMPLATE/2_feature-request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest a new feature (e.g., model, pipeline, task) for this project -title: "[Feature request] Title goes here." -labels: enhancement -assignees: '' - ---- - -**Name of the feature** -*In general, the feature you want added should be supported by HuggingFace's [transformers](https://github.com/huggingface/transformers) library:* - - *If requesting a **model**, it must be listed [here](https://huggingface.co/docs/transformers/index#supported-models).* - - *If requesting a **pipeline**, it must be listed [here](https://huggingface.co/docs/transformers/main_classes/pipelines).* -- *If requesting a **task**, it must be listed [here](https://huggingface.co/tasks).* - - - - -**Reason for request** -*Why is it important that we add this feature? What is your intended use case? Remember, we are more likely to add support for models/pipelines/tasks that are popular (e.g., many downloads), or contain functionality that does not exist (e.g., new input type).* - - - - -**Additional context** -*Add any other context or screenshots about the feature request here.* diff --git a/.github/ISSUE_TEMPLATE/2_new_model.yml b/.github/ISSUE_TEMPLATE/2_new_model.yml new file mode 100644 index 000000000..5b7fe3014 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_new_model.yml @@ -0,0 +1,40 @@ +name: "🌟 New model addition" +description: Submit a proposal/request to implement a new model +labels: [ "New model" ] + +body: + - type: textarea + id: description-request + validations: + required: true + attributes: + label: Model description + description: | + Include important information about the model. + + - type: checkboxes + id: information-tasks + attributes: + label: Prerequisites + description: | + Please note that Transformers.js relies on the model first being supported in [🤗 Transformers](https://github.com/huggingface/transformers) and [🤗 Optimum](https://github.com/huggingface/optimum). If the model you are requesting is not yet supported by either of them, feel free to open up a model request there too. + options: + - label: "The model is supported in Transformers (i.e., listed [here](https://huggingface.co/docs/transformers/index#supported-models-and-frameworks))" + - label: "The model can be exported to ONNX with Optimum (i.e., listed [here](https://huggingface.co/docs/optimum/main/en/exporters/onnx/overview))" + + - type: textarea + id: additional-info + attributes: + label: Additional information + description: | + Please provide additional information about the model here. + If the model is already supported in Transformers, you can provide example Python code to help ensure the JavaScript implementation (and output) matches the original version. + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? diff --git a/.github/ISSUE_TEMPLATE/3_new_pipeline.yml b/.github/ISSUE_TEMPLATE/3_new_pipeline.yml new file mode 100644 index 000000000..ff7b8bff7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_new_pipeline.yml @@ -0,0 +1,40 @@ +name: "🔧 New pipeline addition" +description: Submit a proposal/request to implement a new pipeline +labels: [ "New pipeline" ] + +body: + - type: textarea + id: description-request + validations: + required: true + attributes: + label: Pipeline description + description: | + Put any and all important information related to the pipeline. + + - type: checkboxes + id: information-tasks + attributes: + label: Prerequisites + description: | + Please note that Transformers.js relies on the pipeline first being supported in [🤗 Transformers](https://github.com/huggingface/transformers). If the pipeline you are requesting is not yet supported by Transformers, feel free to open up a feature request for it there too. + options: + - label: "The pipeline is supported in Transformers (i.e., listed [here](https://huggingface.co/docs/transformers/main_classes/pipelines))" + - label: "The task is listed [here](https://huggingface.co/tasks)" + + - type: textarea + id: additional-info + attributes: + label: Additional information + description: | + Please provide additional information about the pipeline here. + If the pipeline is already supported in Transformers, you can provide example Python code to help ensure the JavaScript implementation (and output) matches the original version. + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? diff --git a/.github/ISSUE_TEMPLATE/3_question.md b/.github/ISSUE_TEMPLATE/3_question.md deleted file mode 100644 index d8beec23e..000000000 --- a/.github/ISSUE_TEMPLATE/3_question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Ask a question -about: Ask a question about the library -title: "[Question] Title goes here." -labels: question -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/4_feature-request.yml b/.github/ISSUE_TEMPLATE/4_feature-request.yml new file mode 100644 index 000000000..cda6f9f2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_feature-request.yml @@ -0,0 +1,31 @@ +name: "\U0001F680 Feature request" +description: Submit a proposal/request for a new transformers.js feature +labels: [ "feature" ] +body: + - type: textarea + id: feature-request + validations: + required: true + attributes: + label: Feature request + description: | + A clear and concise description of the feature proposal. + If the feature is already part of the python [Transformers](https://github.com/huggingface/transformers) library, please provide relevant links or example usage. + + - type: textarea + id: motivation + validations: + required: true + attributes: + label: Motivation + description: | + Please outline the motivation for the proposal. Why is it important that we add this feature? What is your intended use case? + + - type: textarea + id: contribution + validations: + required: true + attributes: + label: Your contribution + description: | + Is there any way that you could help, e.g. by submitting a PR? diff --git a/.github/ISSUE_TEMPLATE/5_question.yml b/.github/ISSUE_TEMPLATE/5_question.yml new file mode 100644 index 000000000..2af3acbcf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_question.yml @@ -0,0 +1,13 @@ +name: "🙋 Question" +description: Ask a question about the library +labels: [ "question" ] + +body: + - type: textarea + id: question + validations: + required: true + attributes: + label: Question + description: | + Please enter your question here...