Skip to content

Commit

Permalink
Revamping GitHub Issue workflow (mlflow#1656)
Browse files Browse the repository at this point in the history
Revamp GitHub issue templates
  • Loading branch information
apurva-koti authored and Avrilia Floratou committed Aug 22, 2020
1 parent 42dd37b commit e6be4e1
Show file tree
Hide file tree
Showing 7 changed files with 122 additions and 19 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug Report
about: Use this template for reporting bugs encountered while using MLflow.
labels: 'bug'
title: "[BUG]"
---
Thank you for submitting an issue. Please refer to our [issue policy](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md)
for information on what types of issues we address.

For help with debugging your code, please refer to [Stack Overflow](https://stackoverflow.com/questions/tagged/mlflow).


Please do not delete this template unless you are sure your issue is outside its scope.

### System information
- **Have I written custom code (as opposed to using a stock example script provided in MLflow)**:
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
- **MLflow installed from (source or binary)**:
- **MLflow version (run ``mlflow --version``)**:
- **Python version**:
- **npm version, if running the dev UI**:
- **Exact command to reproduce**:

### Describe the problem
Describe the problem clearly here. Include descriptions of the expected behavior and the actual behavior.

### Code to reproduce issue
Provide a reproducible test case that is the bare minimum necessary to generate the problem.

### Other info / logs
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks,
please include the full traceback. Large logs and files should be attached.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_fix_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Documentation Fix
about: Use this template for proposing documentation fixes/improvements.
labels: 'docs'
title: "[DOC-FIX]"
---
Thank you for submitting an issue. Please refer to our [issue policy](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md)
for information on what types of issues we address.

Please do not delete this template unless you are sure your issue is outside its scope.

### URL(s) with the issue:

Please provide a link to the documentation entry in question.

### Description of proposal (what needs changing):
Provide a clear description. Why is the proposed documentation
better?
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature Request
about: Use this template for feature and enhancement proposals.
labels: 'enhancement'
title: "[FR]"
---
Thank you for submitting an issue. Please refer to our [issue policy](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md)
for information on what types of issues we address.

Please do not delete this template unless you are sure your issue is outside its scope.

-------
## Guidelines

Feature requests typically go through the following lifecycle:

1. Submit feature request with high-level description on GitHub issues (this is what you're doing now)
2. Discuss feature request with a committer, who may ask for a more detailed design
3. After discussion & agreement on feature request, start implementation


## Describe the proposal
Provide a clear high-level description of the feature request in the following sections. Feature requests that are likely to be accepted:
* Are minimal in scope (note that it's always easier to add additional functionality later than remove functionality)
* Are extensible (e.g. if adding an integration with an ML framework, is it possible to add similar integrations with other frameworks?)
* Have user impact & value that justifies the maintenance burden of supporting the feature moving forwards. The [JQuery contributor guide](https://contribute.jquery.org/open-source/#contributing-something-new) has an excellent discussion on this.

### Motivation
What is the use case in mind? Why is it valuable to support, and why is it currently difficult or impossible to achieve? Could the desired functionality alternatively be implemented as a third-party package using MLflow public APIs?

### Proposed Changes
For user-facing changes, what APIs are you proposing to add or modify? For internal changes, what code paths will need to be modified?
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/installation_issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Installation Issues
about: Use this template for reporting bugs encountered while installing MLflow.
labels: 'bug'
title: "[SETUP-BUG]"
---
Thank you for submitting an issue. Please refer to our [issue policy](https://www.github.com/mlflow/mlflow/blob/master/ISSUE_POLICY.md)
for information on what types of issues we address.

Please do not delete this template unless you are sure your issue is outside its scope.

### System information
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
- **MLflow installed from (source or binary)**:
- **MLflow version (run ``mlflow --version``)**:
- **Python version**:
- **Exact command to reproduce**:

### Describe the problem
Provide the exact sequence of commands / steps that you executed before running into the problem.

### Other info / logs
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks,
please include the full traceback. Large logs and files should be attached.
10 changes: 10 additions & 0 deletions ISSUE_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Before filing an issue, make sure to [search for related issues](https://github.com/mlflow/mlflow/issues) and check if
they address yours.

For support (ex. "How do I do X?"), please ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/mlflow).


Our policy is that GitHub issues are
for bug reports, documentation fixes, feature requests,
and installation issues. Please do not delete the issue template placeholder unless you are certain your
issue is outside its scope.
16 changes: 0 additions & 16 deletions ISSUE_TEMPLATE.md

This file was deleted.

9 changes: 6 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,13 @@ Official documentation for MLflow can be found at https://mlflow.org/docs/latest

Community
---------
To discuss MLflow or get help, please subscribe to our mailing list (mlflow-users@googlegroups.com) or
join us on Slack at https://tinyurl.com/mlflow-slack.
For help or questions about MLflow usage (e.g. "how do I do X?") see the `docs <https://mlflow.org/docs/latest/index.html>`_
or `Stack Overflow <https://stackoverflow.com/questions/tagged/mlflow>`_.

To report bugs, please use GitHub issues.
To report a bug, file a documentation issue, or submit a feature request, please open a GitHub issue.

For release announcements and other discussions, please subscribe to our mailing list (mlflow-users@googlegroups.com)
or join us on Slack at https://tinyurl.com/mlflow-slack.

Running a Sample App With the Tracking API
------------------------------------------
Expand Down

0 comments on commit e6be4e1

Please sign in to comment.