Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue templates to github #2575

Closed
wants to merge 1 commit into from
Closed
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
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a bug report. We strive to make Ax a useful and stable library for all our users.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Provide a detailed description of the bug as well as the expected behavior.
validations:
required: true
- type: textarea
id: repro
attributes:
label: Please provide a minimal, reproducible example of the unexpected behavior.
description: Follow [these guidelines](https://stackoverflow.com/help/minimal-reproducible-example) for writing your example.
validations:
required: true
- type: textarea
id: traceback
attributes:
label: Please paste any relevant traceback/logs produced by the example provided.
description: This will be automatically formatted into code, so no need for backticks.
render: shell
- type: input
id: ax-version
attributes:
label: Ax Version
description: What version of Ax are you using?
validations:
required: true
- type: input
id: python-version
attributes:
label: Python Version
description: What version of Python are you using?
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: What operating system are you using?
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow Ax's [Code of Conduct](https://github.com/facebook/Ax/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow Ax's Code of Conduct
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Request a feature or improvement to Ax.
title: "[FEATURE REQUEST]: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a feature! We strive to make Ax a useful and rich library for our users.
- type: textarea
id: motivation
attributes:
label: Motivation
description: Provide a detailed description of the problem you would like to solve via this new feature or improvement.
validations:
required: true
- type: textarea
id: pitch
attributes:
label: Describe the solution you'd like to see implmented in Ax
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe any alternatives you've considered to the above solution
- type: textarea
id: related
attributes:
label: Is this related to an existing issue in Ax or another repository? If so please include links to those Issues here.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow Ax's [Code of Conduct](https://github.com/facebook/Ax/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow Ax's Code of Conduct
required: true
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/3_general_support.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: General Support
description: Get advice on an experiment you're currently running, ask questions about methods, and receive general help with Ax.
title: "[GENERAL SUPPORT]: "
body:
- type: markdown
attributes:
value: |
Thank you for reaching out -- we will do our best to respond to your inquiry promptly.
- type: textarea
id: question
attributes:
label: Question
description: Provide a detailed description of the problem your facing or the question you would like help answering.
validations:
required: true
- type: textarea
id: snippet
attributes:
label: Please provide any relevant code snippet if applicable.
description: This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue you agree to follow Ax's [Code of Conduct](https://github.com/facebook/Ax/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this Ax's Code of Conduct
required: true