From 07053ad316f4cf07ab16f6a55d740a581f2222ca Mon Sep 17 00:00:00 2001 From: naman9271 Date: Sun, 16 Nov 2025 02:07:39 +0530 Subject: [PATCH] fix templates and added --- .github/ISSUE_TEMPLATE/bug_report.yml | 106 +++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++ .../ISSUE_TEMPLATE/default-issue-template.md | 51 -------- .github/ISSUE_TEMPLATE/documentation.yml | 76 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 122 ++++++++++++++++++ .github/ISSUE_TEMPLATE/security.yml | 85 ++++++++++++ 6 files changed, 403 insertions(+), 51 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/default-issue-template.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/security.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..a815f64d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,106 @@ +name: Bug Report +description: Report a bug or unexpected behavior in OpenML +title: "[Bug]: " +labels: ["bug", "needs-triage"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug in OpenML! + + Please check if you're on the correct issue tracker: + - **Website/frontend issues** → [openml.org](https://github.com/openml/openml.org/issues) + - **Dataset issues** → [openml-data](https://github.com/openml/openml-data/issues) + - **Python API** → [openml-python](https://github.com/openml/openml-python/issues) + - **R API** → [openml-r](https://github.com/openml/openml-r/issues) + - **Java API** → [openml-java](https://github.com/openml/openml-java/issues) + - **WEKA bindings** → [openml-weka](https://github.com/openml/openml-weka/issues) + - **RapidMiner** → [openml-rapidminer](https://github.com/openml/openml-rapidminer/issues) + - **.NET API** → [openml-dotnet](https://github.com/openml/openml-dotnet/issues) + + For general API, database, or backend issues, you're in the right place! + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: | + Example: API crashes when calling GET /api/v1/xml/data/features/2 + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Provide detailed steps or code to reproduce the behavior. + placeholder: | + 1. Call API endpoint '...' + 2. With parameters '...' + 3. See error + + Or provide a code snippet: + ``` + https://test.openml.org/api/v1/xml/data/features/2 + ``` + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: "Example: XML response with feature data should be returned" + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? Include error messages, stack traces, or screenshots. + placeholder: "Paste the actual output, error message, or describe what happened" + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Information about your environment + placeholder: | + - OS: [e.g., Ubuntu 22.04, Windows 11, macOS 13] + - Browser: [e.g., Chrome 119, Firefox 120] (if applicable) + - API Version: [e.g., v1] + - PHP Version: [if relevant] + value: | + - OS: + - Browser: + - API Version: + - PHP Version: + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, screenshots, or relevant information about the problem. + placeholder: "Any additional information that might help us understand the issue better" + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Checklist + description: Please confirm the following + options: + - label: I have searched existing issues to avoid duplicates + required: true + - label: I am reporting this to the correct repository + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..138082363 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: true +contact_links: + - name: 💬 Community Discussion + url: https://github.com/openml/OpenML/discussions + about: For questions, ideas, and general discussions about OpenML + - name: 📚 Documentation + url: https://docs.openml.org + about: Visit our documentation for guides and API reference + - name: 🌐 Website Issues + url: https://github.com/openml/openml.org/issues + about: Report issues with the OpenML website or frontend + - name: 🐍 Python API Issues + url: https://github.com/openml/openml-python/issues + about: Report issues with the Python API or scikit-learn bindings diff --git a/.github/ISSUE_TEMPLATE/default-issue-template.md b/.github/ISSUE_TEMPLATE/default-issue-template.md deleted file mode 100644 index eac592c06..000000000 --- a/.github/ISSUE_TEMPLATE/default-issue-template.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Default issue template -about: Issue title -title: '' -labels: '' -assignees: '' - ---- - - - -#### Description - - -#### Steps/Code to Reproduce - - -#### Expected Results - - -#### Actual Results - - - diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..071e1b175 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,76 @@ +name: Documentation Improvement +description: Suggest improvements to documentation +title: "[Docs]: " +labels: ["documentation"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thank you for helping improve OpenML documentation! + + - type: dropdown + id: doc-type + attributes: + label: Documentation Type + description: What type of documentation needs improvement? + options: + - API Documentation + - Code Comments + - README Files + - Setup/Installation Guide + - User Guide + - Developer Guide + - Other + default: 0 + validations: + required: true + + - type: textarea + id: location + attributes: + label: Documentation Location + description: Where is the documentation that needs improvement? + placeholder: | + - URL: https://docs.openml.org/... + - File: README.md, line 45 + - API endpoint: /api/v1/... + validations: + required: true + + - type: textarea + id: issue + attributes: + label: Current Issue + description: What's wrong or missing in the current documentation? + placeholder: | + Example: The API endpoint for data retrieval is not documented, making it difficult for new developers to integrate with OpenML. + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: What should be changed or added? + placeholder: "Describe what you'd like to see in the documentation" + validations: + required: true + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any other information, examples, or references? + placeholder: "Examples from other projects, screenshots, or code snippets" + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Contribution + options: + - label: I am willing to submit a PR to improve this documentation + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..fb4eebec4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,122 @@ +name: Feature Request +description: Suggest a new feature or enhancement for OpenML +title: "[Feature]: " +labels: ["enhancement", "needs-discussion"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + Thank you for suggesting a feature for OpenML! + + Please check if you're on the correct issue tracker: + - **Website/frontend features** → [openml.org](https://github.com/openml/openml.org/issues) + - **Dataset requests** → [openml-data](https://github.com/openml/openml-data/issues) + - **Python API features** → [openml-python](https://github.com/openml/openml-python/issues) + - **R API features** → [openml-r](https://github.com/openml/openml-r/issues) + - **Java API features** → [openml-java](https://github.com/openml/openml-java/issues) + + For general API, database, or backend feature requests, you're in the right place! + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Is your feature request related to a problem? Describe the problem clearly. + placeholder: | + Example: It's difficult to filter tasks by multiple criteria simultaneously, which makes finding relevant experiments time-consuming. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see implemented. + placeholder: | + Example: Add a new API endpoint that accepts multiple filter parameters and returns paginated results with advanced search capabilities. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you've considered. + placeholder: "What other approaches could solve this problem?" + validations: + required: false + + - type: dropdown + id: feature-type + attributes: + label: Feature Type + description: What type of feature is this? + options: + - New API Endpoint + - API Enhancement + - Database Schema Change + - New Task Type + - Performance Improvement + - Security Enhancement + - Documentation + - Other + default: 0 + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Priority + description: How important is this feature to you? + options: + - Low - Nice to have + - Medium - Would improve workflow + - High - Blocking current work + default: 0 + validations: + required: false + + - type: textarea + id: use-cases + attributes: + label: Use Cases + description: Describe specific use cases or scenarios where this feature would be beneficial. + placeholder: | + 1. Researchers analyzing multiple experiments could filter by algorithm family and dataset characteristics + 2. API consumers could reduce the number of requests needed to gather relevant data + validations: + required: false + + - type: textarea + id: implementation + attributes: + label: Implementation Ideas + description: If you have ideas about how this could be implemented, share them here (optional). + placeholder: "Any technical suggestions or implementation approaches?" + validations: + required: false + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, mockups, examples, or references about the feature request. + placeholder: "Links to similar features in other projects, mockups, or any other relevant information" + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Checklist + description: Please confirm the following + options: + - label: I have searched existing issues to avoid duplicates + required: true + - label: I am suggesting this feature to the correct repository + required: true + - label: I am willing to help implement or test this feature + required: false diff --git a/.github/ISSUE_TEMPLATE/security.yml b/.github/ISSUE_TEMPLATE/security.yml new file mode 100644 index 000000000..a992d8e5d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security.yml @@ -0,0 +1,85 @@ +name: Security Vulnerability Report +description: Report a security vulnerability (private and confidential) +title: "[Security]: " +labels: ["security", "needs-triage"] +assignees: [] + +body: + - type: markdown + attributes: + value: | + ## ⚠️ Security Vulnerability Reporting + + **IMPORTANT:** If you've discovered a serious security vulnerability, please do NOT create a public issue. + Instead, please report it privately through GitHub's Security Advisories: + + 1. Go to the [Security tab](https://github.com/openml/OpenML/security) + 2. Click "Report a vulnerability" + 3. Fill out the private vulnerability report form + + For non-critical security improvements or questions, you may continue with this form. + + - type: dropdown + id: severity + attributes: + label: Severity Level + description: How severe is this security issue? + options: + - Low - Minor security improvement suggestion + - Medium - Security enhancement needed + - High - Potential vulnerability (please report privately instead!) + - Critical - Active exploit possible (REPORT PRIVATELY!) + default: 0 + validations: + required: true + + - type: textarea + id: description + attributes: + label: Security Issue Description + description: Describe the security concern (avoid technical exploitation details in public issues) + placeholder: "Describe the security concern at a high level" + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Potential Impact + description: What could happen if this issue is exploited? + placeholder: "What systems or data could be affected?" + validations: + required: true + + - type: textarea + id: affected-components + attributes: + label: Affected Components + description: Which parts of OpenML are affected? + placeholder: | + - API endpoints + - Database + - Authentication system + - etc. + validations: + required: false + + - type: textarea + id: mitigation + attributes: + label: Suggested Mitigation + description: Do you have suggestions for addressing this issue? + placeholder: "Any recommendations for fixing or mitigating this issue?" + validations: + required: false + + - type: checkboxes + id: confirmation + attributes: + label: Responsible Disclosure + description: Please confirm + options: + - label: I understand that critical vulnerabilities should be reported privately + required: true + - label: This is a low-severity security improvement suggestion suitable for public discussion + required: false