From 0759cd47967d9a3a7d9c89f5469e7dfb44ec4106 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:00:59 +0000 Subject: [PATCH 1/8] update issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index f74a719ecd..2f9488280c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -7,16 +7,13 @@ body: value: | Thanks for taking the time to fill out this bug report! 🤗 - Before you submit your bug report: - - - If it is your first time submitting, be sure to check our [bug report guidelines](https://github.com/huggingface/trl/blob/main/CONTRIBUTING.md#did-you-find-a-bug) + 🚩 If it is your first time submitting, be sure to check our [bug report guidelines](https://github.com/huggingface/trl/blob/main/CONTRIBUTING.md#did-you-find-a-bug) - type: textarea id: system-info attributes: label: System Info - description: Please share your system info with us. You can run the command `trl env` and copy-paste its output below. - placeholder: trl version, transformers version, platform, python version, ... + placeholder: Copy-paste the output of `trl env`. validations: required: true From 841848a10acf0e1c00a874067742444fbc9f479c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:20:30 +0000 Subject: [PATCH 2/8] Add checklist for bug report template --- .github/ISSUE_TEMPLATE/bug-report.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2f9488280c..1cab0b50c6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -62,3 +62,22 @@ body: attributes: label: Expected behavior description: "A clear and concise description of what you would expect to happen." + + - type: checkboxes + id: terms + attributes: + label: Checklist + description: | + Before submitting, please confirm that you've completed each of the following. + If an item doesn't apply to your issue, check it anyway to show you've reviewed it. + options: + - label: I have checked that my issue isn't already filed (see [open issues](https://github.com/huggingface/trl/issues?q=is%3Aissue)) + required: true + - label: I have included my system information + required: true + - label: Any code provided is minimal, complete, and reproducible ([more on MREs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)) + required: true + - label: Any code provided is properly formatted in code blocks ([more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)) + required: true + - label: Any traceback provided is complete + required: true \ No newline at end of file From 6d313c89f158d5a8346d554aaf2cbc6f23015bed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:38:29 +0000 Subject: [PATCH 3/8] Fix formatting in bug report template --- .github/ISSUE_TEMPLATE/bug-report.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 1cab0b50c6..80cda24fca 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -63,7 +63,7 @@ body: label: Expected behavior description: "A clear and concise description of what you would expect to happen." - - type: checkboxes + - type: checkboxes id: terms attributes: label: Checklist @@ -71,13 +71,13 @@ body: Before submitting, please confirm that you've completed each of the following. If an item doesn't apply to your issue, check it anyway to show you've reviewed it. options: - - label: I have checked that my issue isn't already filed (see [open issues](https://github.com/huggingface/trl/issues?q=is%3Aissue)) + - label: "I have checked that my issue isn't already filed (see [open issues](https://github.com/huggingface/trl/issues?q=is%3Aissue))" required: true - - label: I have included my system information + - label: "I have included my system information" required: true - - label: Any code provided is minimal, complete, and reproducible ([more on MREs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)) + - label: "Any code provided is minimal, complete, and reproducible ([more on MREs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - - label: Any code provided is properly formatted in code blocks ([more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)) + - label: "Any code provided is properly formatted in code blocks (no screenshot, [more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - - label: Any traceback provided is complete + - label: "Any traceback provided is complete" required: true \ No newline at end of file From 449c2daced679950900fd11f656675395422d264 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:43:36 +0000 Subject: [PATCH 4/8] Update bug report template with additional instructions for code formatting and screenshots --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 80cda24fca..55d55b4cc3 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -13,7 +13,11 @@ body: id: system-info attributes: label: System Info - placeholder: Copy-paste the output of `trl env`. + description: | + Please provide information about your system: platform, Python version, PyTorch version, Transformers version, devices, TRL version, ... + You can get this information by running `trl env` in your terminal. + + placeholder: Copy-paste the output of `trl env` validations: required: true @@ -77,7 +81,7 @@ body: required: true - label: "Any code provided is minimal, complete, and reproducible ([more on MREs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - - label: "Any code provided is properly formatted in code blocks (no screenshot, [more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" + - label: "Any code provided is properly formatted in code blocks, screenshots ([more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - label: "Any traceback provided is complete" required: true \ No newline at end of file From 922079debc0cca447fde1d81c5ebc33973430a3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:46:00 +0000 Subject: [PATCH 5/8] Update bug report template with code formatting instructions --- .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 55d55b4cc3..7ad26102f8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -81,7 +81,7 @@ body: required: true - label: "Any code provided is minimal, complete, and reproducible ([more on MREs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - - label: "Any code provided is properly formatted in code blocks, screenshots ([more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" + - label: "Any code provided is properly formatted in code blocks, (no screenshot, [more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - label: "Any traceback provided is complete" required: true \ No newline at end of file From b495de42eacea3c4de1438a06b6b0e09bdc5ed41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:48:22 +0000 Subject: [PATCH 6/8] Update bug report template with code examples --- .github/ISSUE_TEMPLATE/bug-report.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7ad26102f8..a623601a74 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -52,12 +52,18 @@ body: Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. placeholder: | - Steps to reproduce the behavior: + ```python + from trl import ... - 1. - 2. - 3. + ``` + outputs: + + ``` + Traceback (most recent call last): + File "example.py", line 42, in + ... + ``` - type: textarea id: expected-behavior From 101ed97f5fb9e4e9d9aa4e5cc0325f909cea1558 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Quentin=20Gallou=C3=A9dec?= Date: Tue, 5 Nov 2024 11:53:15 +0000 Subject: [PATCH 7/8] Update code block placeholder in bug report template --- .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 a623601a74..ebda286f6e 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -51,7 +51,7 @@ body: Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code. - placeholder: | + value: | ```python from trl import ... From a4ec35ffcffda9d1439912892d318eec11055a46 Mon Sep 17 00:00:00 2001 From: Kashif Rasul Date: Mon, 11 Nov 2024 13:28:03 +0100 Subject: [PATCH 8/8] Update .github/ISSUE_TEMPLATE/bug-report.yml --- .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 ebda286f6e..8446a33af6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -90,4 +90,4 @@ body: - label: "Any code provided is properly formatted in code blocks, (no screenshot, [more on code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks))" required: true - label: "Any traceback provided is complete" - required: true \ No newline at end of file + required: true