From bd5b4852ed11de6d0fb0f5c886f0ae948215c8e9 Mon Sep 17 00:00:00 2001 From: captivus <366332+captivus@users.noreply.github.com> Date: Thu, 25 Jul 2024 07:08:52 -0500 Subject: [PATCH] Update bug report template to include installation method --- .github/ISSUE_TEMPLATE/bug-report.md | 4 ++++ docs/installation.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 579ffe532e..99d451c3a7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -30,3 +30,7 @@ If your project includes a debug_log_file.txt, kindly upload it from your_projec ## System Information Please copy and paste the output of the `gpte --sysinfo` command as part of your bug report. + +## Installation Method + +Please specify whether you installed GPT-Engineer using `pip install` or by building the repository. diff --git a/docs/installation.rst b/docs/installation.rst index 6dc776bbcf..b3ab8a65bc 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,6 +19,10 @@ This is the preferred method to install ``gpt-engineer``, as it will always inst If you don't have `pip`_ installed, this `Python installation guide`_ can guide you through the process. +.. note:: + + When reporting bugs, please specify your installation method (using `pip install` or by building the repository) in the "Installation Method" section of the bug report template. + .. _pip: https://pip.pypa.io .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/