as per the suggestions from Cyril and Willy on the mailing list: Message-ID: <[email protected]>
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 <[email protected]> --- .github/ISSUE_TEMPLATE/Bug.md | 67 ++++++++++++++++++++++++----------- .github/ISSUE_TEMPLATE/Code-Report.md | 55 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature.md | 30 ++++++++-------- 3 files changed, 117 insertions(+), 35 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 54f0475..038330a 100644 --- a/.github/ISSUE_TEMPLATE/Bug.md +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -25,27 +25,22 @@ Thanks for understanding, and for contributing to the project! --> -## Output of `haproxy -vv` and `uname -a` -<!-- Put it in code blocks ```: --> +## Detailed description of the problem -``` -(paste your output here) -``` +<!-- +In this section, please try to concentrate on observations. Only describe what you +observed directly. +--> -## What's the configuration? +## Expected behavior <!-- -Include as much configuration as possible, including global and default sections. -Replace confidential data like domain names and IP addresses. +Explain why you consider the described behavior (above) to be wrong. What did you expect instead? -Put it in code blocks ```: +Most likely this is a mismatch between HAProxy's documentation and HAProxy's behavior. --> -``` -(paste your output here) -``` - ## 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 +## Do you have any idea what may have caused this? + +## Do you have an idea how to solve the issue? + +## What is your configuration? <!-- -In this section, please try to concentrate on observations, so only describe -what you observed directly. +Include as much configuration as possible, including global and default sections. +Replace confidential data like domain names and IP addresses. + +Put it in code blocks ```: --> -## Expected behavior +``` +(paste your output here) +``` + +## Output of `haproxy -vv` and `uname -a` + +<!-- Put it in code blocks ```: --> + +``` +(paste your output here) +``` + +## If HAProxy crashed: Last outputs and backtraces <!-- -Describe what you would like HAProxy to do differently. +If HAProxy crashed then please provide: + + 1. The last output from your HAProxy logs (e.g. from journalctl or syslog). + 2. A backtrace from a coredump (`t a a bt full`). + +Put all results in code blocks ```: --> -## Do you have any idea what may have caused this? +``` +(paste your output here) +``` -## Do you have an idea how to solve the issue? +## Additional information (if helpful) +<!-- +Any additional information about your environment that may be useful to know about. For example: + - Any local patches applied. + - Environment specificities + - Unusual workload + - Interesting observations or coindidences with events on other components +--> diff --git a/.github/ISSUE_TEMPLATE/Code-Report.md b/.github/ISSUE_TEMPLATE/Code-Report.md new file mode 100644 index 0000000..d1bcd49 --- /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' +--- + +<!-- + +Welcome! - We kindly ask that you: + + 1. Fill out the issue template below - not doing so needs a good reason. + 2. Use the forum or the mailing list if you have a question rather than a bug or feature request. + +The forum is at: https://discourse.haproxy.org/ + +The mailing list (no need to subscribe) is: [email protected] +Subscribe to the list: [email protected] +Unsubscribe from the list: [email protected] + +Forum and mailing list are correct places for questions about HAProxy or general suggestions +and topics, e.g. usage or documentation questions! This issue tracker is for tracking bugs and +feature requests directly relating to the development of the software itself. + +Thanks for understanding, and for contributing to the project! + +--> + +## Code Report + +<!-- +In this section please provide: + 1. Information about the tool that generated the report (e.g. valgrind-3.11.0 or Coverity). + 2. Provide the full output of the tool in code blocks (```). +--> + +Tool: (tool name goes here) + +``` +(paste your output here) +``` + + +## Output of `haproxy -vv` and `uname -a` + +<!-- +Please add the output of haproxy -vv you are currently using here, this helps us +later to see what has changed in HAProxy when we revisit this issue after some +time. + +Put it in code blocks ```: +--> + +``` +(paste your output here) +``` diff --git a/.github/ISSUE_TEMPLATE/Feature.md b/.github/ISSUE_TEMPLATE/Feature.md index 8f1a9df..eaaa7e5 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` - -<!-- -Please add the output of haproxy -vv you are currently using here, this helps us -later to see what has changed in HAProxy when we revisit this issue after some -time. - -Put it in code blocks ```: ---> - -``` -(paste your output here) -``` - ## What should haproxy do differently? Which functionality do you think we should add? <!-- Please describe the feature you would like us to add here. --> - ## What are you trying to do? <!-- @@ -53,3 +38,18 @@ This section should contain a brief description what you're trying to do, which would be possible after implementing the new feature. --> +## Output of `haproxy -vv` and `uname -a` + +<!-- +Please add the output of haproxy -vv you are currently using here, this helps us +later to see what has changed in HAProxy when we revisit this issue after some +time. + +*PLEASE DO NOT LEAVE THIS OUT* + +Put it in code blocks ```: +--> + +``` +(paste your output here) +``` -- 2.7.4
