From 4cc89b228ad317f1627119a0c87100b6ac7c2b4f Mon Sep 17 00:00:00 2001 From: Jennifer Wei <97625454+jnwei@users.noreply.github.com> Date: Wed, 22 Oct 2025 09:52:41 +0700 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ .../ISSUE_TEMPLATE/openfold-issue-template.md | 26 ------------- .../openfold3-issue-template.md | 37 +++++++++++++++++++ 3 files changed, 57 insertions(+), 26 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/openfold-issue-template.md create mode 100644 .github/ISSUE_TEMPLATE/openfold3-issue-template.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description 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/openfold-issue-template.md b/.github/ISSUE_TEMPLATE/openfold-issue-template.md deleted file mode 100644 index ad094697a..000000000 --- a/.github/ISSUE_TEMPLATE/openfold-issue-template.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: OpenFold issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - - -**Related PR:** - - -- [ ] <> - -**Related issues:** - -- [ ] -- [ ] -- [ ] - -Preferably, each issue should be -- linked to the branch through which the changes are introduced. You can do this on the right side under the "Development" tag once your draft project board item has been converted into an issue. -- annotated with appropriate labels. Right side, "Labels" -- assigned to the people working on it, Right side, "Assignees" diff --git a/.github/ISSUE_TEMPLATE/openfold3-issue-template.md b/.github/ISSUE_TEMPLATE/openfold3-issue-template.md new file mode 100644 index 000000000..1d56b0fdf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/openfold3-issue-template.md @@ -0,0 +1,37 @@ +--- +name: OpenFold3 issue template +about: Report an bug +title: "[BUG]" +labels: '' +assignees: '' + +--- + +----------------------------------------- +Thank you for taking the time to file a bug report. Please help us help you. Providing as much information as possible regarding the system information, the queries submitted and the configuration settings will allow us to more easily debug the issue. + +PLEASE DELETE THIS SECTION AFTER YOU HAVE READ IT +----------------------------------------- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. If possible please include: +- A query (e.g. json) that triggers the issue +- A `runner.yml` file with custom configuration settings if one was used +- A copy of the command line arguments used. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Configuration (please complete the following information):** + - OS: [e.g. Ubuntu 20.04] + - Python version (if relevant): + - Installation path (e.g. conda / pip / build from repo) + +**Additional context** +Add any other context about the problem here. From 72645d8dd4f4cbc93e498079b870927d53819306 Mon Sep 17 00:00:00 2001 From: Jennifer Wei <97625454+jnwei@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:42:04 +0700 Subject: [PATCH 2/3] Update openfold3-issue-template.md --- .github/ISSUE_TEMPLATE/openfold3-issue-template.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/openfold3-issue-template.md b/.github/ISSUE_TEMPLATE/openfold3-issue-template.md index 1d56b0fdf..b73d0a14f 100644 --- a/.github/ISSUE_TEMPLATE/openfold3-issue-template.md +++ b/.github/ISSUE_TEMPLATE/openfold3-issue-template.md @@ -1,8 +1,8 @@ --- name: OpenFold3 issue template -about: Report an bug +about: Report a bug title: "[BUG]" -labels: '' +labels: 'bug,needs-triage' assignees: '' --- @@ -10,6 +10,8 @@ assignees: '' ----------------------------------------- Thank you for taking the time to file a bug report. Please help us help you. Providing as much information as possible regarding the system information, the queries submitted and the configuration settings will allow us to more easily debug the issue. +OpenFold3 has documentation available at https://openfold3.readthedocs.io/en/latest/ with several how-to guides. Check there to see if your question might already be answered. + PLEASE DELETE THIS SECTION AFTER YOU HAVE READ IT ----------------------------------------- @@ -20,16 +22,17 @@ A clear and concise description of what the bug is. Steps to reproduce the behavior. If possible please include: - A query (e.g. json) that triggers the issue - A `runner.yml` file with custom configuration settings if one was used -- A copy of the command line arguments used. +- Comand line arguments used. **Expected behavior** A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Stack trace** +If applicable, please add the stack trace / log of your run **Configuration (please complete the following information):** - OS: [e.g. Ubuntu 20.04] + - GPU used and memory available - Python version (if relevant): - Installation path (e.g. conda / pip / build from repo) From 85db8453cc2d0117e28c0c4dd438c52d5fa7ef9d Mon Sep 17 00:00:00 2001 From: Jennifer Wei <97625454+jnwei@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:43:48 +0700 Subject: [PATCH 3/3] Enhance feature request template with assistance section Added a section for feature assistance to encourage collaboration on feature requests. --- .github/ISSUE_TEMPLATE/feature_request.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..2954ec55b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' +labels: 'enhancement' assignees: '' --- @@ -18,3 +18,7 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. + +**Feature Assistance** +Let us know if you are interested in working on this idea yourself with expert guidance/assistance, or in working together with us on this feature idea. +