From 8564f5381221e04baf6ec167e02929337c3b196a Mon Sep 17 00:00:00 2001 From: Lukas Tribus Date: Mon, 17 Aug 2020 20:17:11 +0200 Subject: [PATCH] DOC: overhauling github issue templates as per the suggestions from Cyril and Willy on the mailing list: Message-ID: and with direct contributions from Tim, this changes large parts of the bug issue template. The Feature template is also updated as well as a new template for Code Reports is introduced. Co-authored-by: Tim Duesterhus --- .github/ISSUE_TEMPLATE/Bug.md | 83 ++++++++++++++++++--------- .github/ISSUE_TEMPLATE/Code-Report.md | 55 ++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature.md | 30 +++++----- 3 files changed, 125 insertions(+), 43 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Code-Report.md diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md index 54f0475f7..038330a6c 100644 --- a/.github/ISSUE_TEMPLATE/Bug.md +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -25,26 +25,21 @@ Thanks for understanding, and for contributing to the project! --> -## Output of `haproxy -vv` and `uname -a` - - -``` -(paste your output here) -``` - -## What's the configuration? +## Detailed description of the problem -``` -(paste your output here) -``` +## Expected behavior + + ## Steps to reproduce the behavior @@ -57,20 +52,52 @@ this is possible), the easier it is for the project developers to fix it! 2. 3. -## Actual behavior - - - -## Expected behavior - - - ## Do you have any idea what may have caused this? ## Do you have an idea how to solve the issue? +## What is your configuration? + + + +``` +(paste your output here) +``` + +## Output of `haproxy -vv` and `uname -a` + + + +``` +(paste your output here) +``` + +## If HAProxy crashed: Last outputs and backtraces + + + +``` +(paste your output here) +``` + +## Additional information (if helpful) + + diff --git a/.github/ISSUE_TEMPLATE/Code-Report.md b/.github/ISSUE_TEMPLATE/Code-Report.md new file mode 100644 index 000000000..d1bcd49bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Code-Report.md @@ -0,0 +1,55 @@ +--- +name: Code Report +about: File a Code Report (for example from coverity or valgrind) +labels: 'type: code-report' +--- + + + +## Code Report + + + +Tool: (tool name goes here) + +``` +(paste your output here) +``` + + +## Output of `haproxy -vv` and `uname -a` + + + +``` +(paste your output here) +``` diff --git a/.github/ISSUE_TEMPLATE/Feature.md b/.github/ISSUE_TEMPLATE/Feature.md index 8f1a9dfba..eaaa7e5db 100644 --- a/.github/ISSUE_TEMPLATE/Feature.md +++ b/.github/ISSUE_TEMPLATE/Feature.md @@ -25,27 +25,12 @@ Thanks for understanding, and for contributing to the project! --> -## Output of `haproxy -vv` and `uname -a` - - - -``` -(paste your output here) -``` - ## What should haproxy do differently? Which functionality do you think we should add? - ## What are you trying to do? +## Output of `haproxy -vv` and `uname -a` + + + +``` +(paste your output here) +```