From 9a122ef38b8e8135b92640d9aefc416be66d46d9 Mon Sep 17 00:00:00 2001 From: Lucas Meyer Date: Mon, 7 Apr 2025 10:12:11 +0200 Subject: [PATCH 1/5] Add template for bug reports --- .github/ISSUE_TEMPLATE/bug-report.yml | 37 +++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..223e0717 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,37 @@ +name: Bug Report +description: Create a report to help us reproduce and fix the bug +title: "[Bug]: " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: > + Thank you for taking the time to file a bug report. + Before creating a new issue, please make sure to take a few minutes to check for already existing issues or information about the bug. + - type: textarea + attributes: + label: "Describe the issue:" + validations: + required: true + - type: textarea + attributes: + label: "Reproduce the code example:" + description: > + A short code example that reproduces the problem/missing feature. + It should be self-contained. + placeholder: | + << your code here >> + render: python + validations: + required: true + - type: textarea + attributes: + label: "Context for the issue:" + description: | + Please explain how this issue affects your intended use of the Well. + You can also provide additional context that you think might be relevant. + placeholder: | + << your explanation here >> + validations: + required: false From e7cecff7571b724f466c8c8f761baf8a876aecfe Mon Sep 17 00:00:00 2001 From: Lucas Meyer Date: Tue, 8 Apr 2025 13:27:18 +0200 Subject: [PATCH 2/5] Update already existing issue message --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 223e0717..eb9c9323 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -8,7 +8,7 @@ body: attributes: value: > Thank you for taking the time to file a bug report. - Before creating a new issue, please make sure to take a few minutes to check for already existing issues or information about the bug. + Before creating a new issue, you can have a quick look to the [FAQ](https://github.com/PolymathicAI/the_well/discussions/categories/q-a?discussions_q=category%3AQ%26A+) and [existing issues](https://github.com/PolymathicAI/the_well/issues). - type: textarea attributes: label: "Describe the issue:" From ed3d93eeba9a58b6d8c876a136a9facd93c84200 Mon Sep 17 00:00:00 2001 From: Lucas Meyer Date: Tue, 20 May 2025 13:46:25 +0200 Subject: [PATCH 3/5] Add version and environment to issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index eb9c9323..6d87b246 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -16,7 +16,7 @@ body: required: true - type: textarea attributes: - label: "Reproduce the code example:" + label: "Code to reproduce the issue:" description: > A short code example that reproduces the problem/missing feature. It should be self-contained. @@ -25,6 +25,25 @@ body: render: python validations: required: true + - type: textarea + attributes: + label: "Version" + description: | + Which version of the Well are you using? + (You can obtain the version by running `python -c "import the_well; print(the_well.__version__)"`) + placeholder: | + << your version here >> + validations: + required: true + - type: textarea + attributes: + label: "Environment" + description: | + Which environment are you using? List the packages you have installed along the Well. + placeholder: | + << your environment here >> + validations: + required: true - type: textarea attributes: label: "Context for the issue:" From c8c7a6ba0103f94f4602eb412650f65feeb39a39 Mon Sep 17 00:00:00 2001 From: Lucas Meyer Date: Tue, 20 May 2025 13:53:25 +0200 Subject: [PATCH 4/5] Add code snippet to obtain version and environment --- .github/ISSUE_TEMPLATE/bug-report.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 6d87b246..381bc0bf 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -12,6 +12,8 @@ body: - type: textarea attributes: label: "Describe the issue:" + placeholder: | + << your issue description here >> validations: required: true - type: textarea @@ -30,7 +32,10 @@ body: label: "Version" description: | Which version of the Well are you using? - (You can obtain the version by running `python -c "import the_well; print(the_well.__version__)"`) + You can obtain the version by running the following command: + ```sh + python -c "import the_well; print(the_well.__version__)" + ``` placeholder: | << your version here >> validations: @@ -40,6 +45,10 @@ body: label: "Environment" description: | Which environment are you using? List the packages you have installed along the Well. + In case you use pip, you can obtain the list of installed packages by running the following command: + ```sh + pip freeze + `` placeholder: | << your environment here >> validations: From 4269d25973520e7e082cc1ee5873aadd81efaa88 Mon Sep 17 00:00:00 2001 From: Lucas Meyer Date: Tue, 20 May 2025 13:55:36 +0200 Subject: [PATCH 5/5] Fix typo in code snippet --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 381bc0bf..f0c1b75e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -48,7 +48,7 @@ body: In case you use pip, you can obtain the list of installed packages by running the following command: ```sh pip freeze - `` + ``` placeholder: | << your environment here >> validations: