diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..d5f299471 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,73 @@ +### Description + + + +### Environment + +- FLAML version: +- Python version: +- Operating System: + +### Steps to Reproduce (for bugs) + + + +1. Step 1 +1. Step 2 +1. ... + +### Expected Behavior + + + +### Actual Behavior + + + +### Screenshots / Logs (if applicable) + + + +### Additional Information + + + +### Possible Solution (if you have one) + + + +### Is this a Bug or Feature Request? + + + +### Priority + + + +### Difficulty + + + +### Any related issues? + + + +### Any relevant discussions? + + + +### Checklist + + + +- [ ] I have searched for similar issues and didn't find any duplicates. +- [ ] I have provided a clear and concise description of the issue. +- [ ] I have included the necessary environment details. +- [ ] I have outlined the steps to reproduce the issue. +- [ ] I have included any relevant logs or screenshots. +- [ ] I have indicated whether this is a bug or a feature request. +- [ ] I have set the priority and difficulty levels. + +### Additional Comments + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..65061adea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,53 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] + +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: What went wrong? + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: | + Steps to reproduce the behavior: + + 1. Step 1 + 2. Step 2 + 3. ... + 4. See error + placeholder: How can we replicate the issue? + - type: textarea + id: modelused + attributes: + label: Model Used + description: A description of the model that was used when the error was encountered + placeholder: gpt-4, mistral-7B etc + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + placeholder: What should have happened? + - type: textarea + id: screenshots + attributes: + label: Screenshots and logs + description: If applicable, add screenshots and logs to help explain your problem. + placeholder: Add screenshots here + - type: textarea + id: additional_information + attributes: + label: Additional Information + description: | + - FLAML Version: + - Operating System: + - Python Version: + - Related Issues: + - Any other relevant information. + placeholder: Any additional details diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0086358db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..e8a63df7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,26 @@ +name: Feature Request +description: File a feature request +labels: ["enhancement"] +title: "[Feature Request]: " + +body: + - type: textarea + id: problem_description + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + placeholder: What problem are you trying to solve? + + - type: textarea + id: solution_description + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: How do you envision the solution? + + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + placeholder: Any additional information diff --git a/.github/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml new file mode 100644 index 000000000..5098c7513 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_issue.yml @@ -0,0 +1,41 @@ +name: General Issue +description: File a general issue +title: "[Issue]: " +labels: [] + +body: + - type: textarea + id: description + attributes: + label: Describe the issue + description: A clear and concise description of what the issue is. + placeholder: What went wrong? + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: | + Steps to reproduce the behavior: + + 1. Step 1 + 2. Step 2 + 3. ... + 4. See error + placeholder: How can we replicate the issue? + - type: textarea + id: screenshots + attributes: + label: Screenshots and logs + description: If applicable, add screenshots and logs to help explain your problem. + placeholder: Add screenshots here + - type: textarea + id: additional_information + attributes: + label: Additional Information + description: | + - FLAML Version: + - Operating System: + - Python Version: + - Related Issues: + - Any other relevant information. + placeholder: Any additional details diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 88473b0f5..f0991bd04 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,8 +12,7 @@ ## Checks - - +- I've used [pre-commit](https://microsoft.github.io/FLAML/docs/Contribute#pre-commit) to lint the changes in this PR (note the same in integrated in our CI checks). - [ ] I've included any doc changes needed for https://microsoft.github.io/FLAML/. See https://microsoft.github.io/FLAML/docs/Contribute#documentation to build and test documentation locally. - [ ] I've added tests (if relevant) corresponding to the changes introduced in this PR. - [ ] I've made sure all auto checks have passed.