Skip to content

Commit

Permalink
Update Issue Templates (#2674)
Browse files Browse the repository at this point in the history
Summary:
## Motivation

Updates the issue templates to utilize the formatted issue forms: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Pull Request resolved: #2674

Test Plan:
Tested by committing the changes to the main branch of my fork.

Choosing an issue type:
<img width="1189" alt="Screenshot 2025-01-14 at 11 29 14 AM" src="https://github.com/user-attachments/assets/6ea2b5d0-b0c0-4ada-9ff7-8025af0c50ba" />

Bug Report:
<img width="836" alt="Screenshot 2025-01-14 at 11 29 35 AM" src="https://github.com/user-attachments/assets/192c1b5c-a676-4252-8ff5-8b75d5c5583c" />

Feature Request:
<img width="999" alt="Screenshot 2025-01-14 at 11 36 23 AM" src="https://github.com/user-attachments/assets/fe32d8cc-45b0-48dc-befb-d3bfb10ff662" />

## Related PRs

This was modified from the templates used in Ax: facebook/Ax#2575

Reviewed By: esantorella

Differential Revision: D68158533

Pulled By: saitcakmak

fbshipit-source-id: 7f9e06ac59a5e8f3bc34a83f5be50ec586a24962
  • Loading branch information
saitcakmak authored and facebook-github-bot committed Jan 14, 2025
1 parent ccef69f commit a3d47f4
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 93 deletions.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

42 changes: 0 additions & 42 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐛 Bug Report
description: File a bug report.
labels: ["bug"]
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out a bug report. We strive to make BoTorch 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. Please ensure that the provided example is complete & runnable, including with dummy data if necessary.
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: botorch-version
attributes:
label: BoTorch Version
description: What version of BoTorch 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: false
- type: input
id: os
attributes:
label: Operating System
description: What operating system are you using?
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow BoTorch's [Code of Conduct](https://github.com/pytorch/botorch/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow BoTorch's Code of Conduct
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: General Support & Discussions
url: https://github.com/pytorch/botorch/discussions
about: Please use discussions for general support requests and to ask broader questions related to BoTorch. This includes any support request that does not require changes to BoTorch source code.
- name: Bug Bounty Program
url: https://bugbounty.meta.com/
about: Meta has a bounty program for the safe disclosure of security bugs. Please go through the process outlined on that page and do not file a public issue.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 🚀 Feature Request
description: Request a feature or improvement to BoTorch.
labels: ["enhancement"]
title: "[FEATURE REQUEST]: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a feature! We strive to make BoTorch 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 implemented in BoTorch.
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 BoTorch or another repository? If so please include links to those Issues here.
- type: dropdown
id: pull-request
attributes:
label: Pull Request
description: Are you willing to open a pull request implementing this feature? (See [Contributing to BoTorch](https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md))
options:
- "Yes"
- "No"
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow BoTorch's [Code of Conduct](https://github.com/pytorch/botorch/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow BoTorch's Code of Conduct
required: true

0 comments on commit a3d47f4

Please sign in to comment.