From 6e498e9611e175bd54bb26f39db7100dcfa38b40 Mon Sep 17 00:00:00 2001 From: Rachel Clune Date: Tue, 3 Feb 2026 14:14:19 -0800 Subject: [PATCH 1/2] Create Issue Templates Created templates for bug reports, feature requests, and usage questions. The main goal is to encourage users to provide files and details required to understand their problem/request/question so that minimal back and forth needs to occur before a solution is reached. --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++ .../question-or-unexpected-outputs.md | 28 ++++++++++++++++++ 3 files changed, 77 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..190fdfee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to inform us of any issues that occur when using the models + in foundry. +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise (2-3 sentences) description of what the bug is. + +**To Reproduce** +Please describe any: +- [ ] steps taken +- [ ] system architectures (if relevant) +- [ ] structure files - make a dummy structure if you cannot share your actual work +- [ ] input files - make dummy input files if you cannot share your actual work +- [ ] errors and logs, a screenshot of the pertinent parts of your error message is usually fine + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots of the output structures to help describe your problem. + +**Additional context** +Add any other details that are useful for understanding the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..7c3da047 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEAT]" +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise (2-3 sentence) description of what the problem is. Ex. I'm always have to do this post-processing step... + +**Describe the solution you'd like** +A clear and concise (2-3 sentence) description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description (2-3 sentence) of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md b/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md new file mode 100644 index 00000000..50abe03b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md @@ -0,0 +1,28 @@ +--- +name: Question or Unexpected Outputs +about: Ask a question about how to use one of the models to accomplish your protein + design task +title: "[QUEST]" +labels: question +assignees: '' + +--- + +** Consider asking your question on [Slack](https://join.slack.com/t/proteinmodelfoundry/shared_invite/zt-3kpwru8c6-nrmTW6LNHnSE7h16GNnfLA)! ** Your question will reach a wider audience and likely get answered faster. + +**Describe the issue/question** +A clear and concise (2-3 sentences) description of what you're trying to accomplish and where you're getting stuck. + +**To Reproduce** +Please describe any: +- [ ] steps taken +- [ ] system architectures (if relevant) +- [ ] structure files - make a dummy structure if you cannot share your actual work +- [ ] input files - make dummy input files if you cannot share your actual work +- [ ] errors and logs as necessary, a screenshot of the pertinent parts of your error message is usually fine + +**Expected behavior** +A clear and concise (2-3 sentence) description of what you expected to happen. If you have an example, images or files would be good to include. + +**Additional context** +Add any other details that are useful for understanding the problem here. From 7734cd1bbad4a872f535e4bbe56c599d018ba8d8 Mon Sep 17 00:00:00 2001 From: Rachel Clune Date: Tue, 3 Feb 2026 16:11:14 -0800 Subject: [PATCH 2/2] Revise issue template for clarity and detail Updated issue template to include a request for images of expected behavior and streamlined the reproduction steps section. --- .../ISSUE_TEMPLATE/question-or-unexpected-outputs.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md b/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md index 50abe03b..8eba1dbe 100644 --- a/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md +++ b/.github/ISSUE_TEMPLATE/question-or-unexpected-outputs.md @@ -11,18 +11,15 @@ assignees: '' ** Consider asking your question on [Slack](https://join.slack.com/t/proteinmodelfoundry/shared_invite/zt-3kpwru8c6-nrmTW6LNHnSE7h16GNnfLA)! ** Your question will reach a wider audience and likely get answered faster. **Describe the issue/question** -A clear and concise (2-3 sentences) description of what you're trying to accomplish and where you're getting stuck. +A clear and concise (2-3 sentences) description of what you're trying to accomplish and where you're getting stuck. Images of the expected behavior should be provided when possible. **To Reproduce** Please describe any: +- [ ] errors and logs, a screenshot of the pertinent parts of your error message is usually fine +- [ ] input files - make dummy input files if you cannot share your actual work +- [ ] structure files - make a dummy structure if you cannot share your actual work - [ ] steps taken - [ ] system architectures (if relevant) -- [ ] structure files - make a dummy structure if you cannot share your actual work -- [ ] input files - make dummy input files if you cannot share your actual work -- [ ] errors and logs as necessary, a screenshot of the pertinent parts of your error message is usually fine - -**Expected behavior** -A clear and concise (2-3 sentence) description of what you expected to happen. If you have an example, images or files would be good to include. **Additional context** Add any other details that are useful for understanding the problem here.