Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/default-issue-template.md

This file was deleted.

76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
122 changes: 122 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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
Loading