FSchumacher commented on code in PR #5712: URL: https://github.com/apache/jmeter/pull/5712#discussion_r981187451
########## xdocs/building.xml: ########## @@ -109,22 +109,20 @@ Check that patch does not break JUnit tests by running: </p> <source>./gradlew test</source> -<h3>Create a PR using GIT</h3> +<h3>Create a pull request using Git</h3> <ul> - <li>Open a bugzilla issue, see <a target="_blank" href="issues.html">Issues page</a></li> - <li>Fork <a href="https://www.github.com/apache/jmeter"; >Apache JMeter mirror</a></li> - <li>Clone your forked repository locally : <source>git clone https://github.com/yourid/jmeter/</source></li> - <li>Create a branch using for example bugzilla id: <source>git branch BUGID</source></li> - <li>Checkout the new branch : <source>git checkout BUGID</source></li> - <li>commit your fix there : <source>git commit -m 'Fix to BUGID' list of files</source></li> + <li>Fork <a href="https://www.github.com/apache/jmeter";>Apache JMeter mirror</a></li> + <li>Clone your forked repository locally: <source>git clone https://github.com/yourid/jmeter.git</source></li> + <li>Create a branch using for example issue id: <source>git branch gh123-thread-group-typo</source></li> + <li>Checkout the new branch: <source>git checkout gh123-thread-group-typo</source></li> + <li>Commit your fix there: <source>git commit -m 'Fix to BUGID' list of files</source></li> <li>Please avoid creating merge commits in the PR. We embrace small changes, and merge commits are harder to review</li> - <li>Add JMeter repository as upstream : <source>git remote add upstream http://www.github.com/apache/jmeter</source></li> - <li>push it : <source>git push origin BUGID</source></li> - <li>Create a PR and link it in the bugzilla issue</li> - <li>Or create a diff and add as attachment to bugzilla issue <source>git diff > BUGID.patch</source></li> + <li>Add JMeter repository as upstream: <source>git remote add upstream https://www.github.com/apache/jmeter.git</source></li> + <li>Push it: <source>git push upstream gh123-thread-group-typo</source></li> Review Comment: I have never tried this, but does it work for all users? ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. + "I also need this" comments cause notifications, and the comment itself does not add much to the discussion. + Instead, prefer adding reactions to the first comment of an existing issue, so the issues could be sorted (see + <a href="https://github.com/apache/jmeter/issues?q=sort%3Areactions-%2B1-desc";>Most voted issues</a>). + </p> + <p> + Please make sure that you describe the enhancement in sufficient detail. It might be a good idea to start with a use-case. + </p> + <p> + There are several options to propose an enhancement request: + <dl> + <dt>GitHub issue</dt> + <dd> + <p> + You could <a href="https://github.com/apache/jmeter/issues/new/choose";>file an issue on GitHub</a> to start a discussion + and gather opinions. GitHub issues allow + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax";>basic formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting";>advanced formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files";>attaching files</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code";>syntax highlight</a>, + <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists";>task lists</a>, + reactions, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests";>references to the other + issues and the source code</a>. + </p> + <p> + When you create an issue at GitHub, it suggests one of the templates (e.g. "Bug report", + "Feedback about the manual", "Feature Request", "Regression"), and it guides which information is required for each case. + You could read more on <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue";>creating issues</a> in + GitHub documentation. + </p> + </dd> + <dt>Mailing list discussion</dt> + <dd> + <p> + If you are not sure if something is an enhancement, or if you are unsure regarding the possible solutions, + it might be a good idea to start a discussion on <a href="https://jmeter.apache.org/mail2.html#JMeterDev";>JMeter dev mailing list</a> + </p> + </dd> + <dt>GitHub pull request</dt> + <dd> + <p> + If you are positive regarding the solution, you could start a discussion by creating a + <a href="https://github.com/apache/jmeter/pulls";>pull request on GitHub</a>. + Pull requests are not much different from issues, however, sometimes it is easier to discuss with code at hand. + For instance, if you fix a typo or make other small fixes, there's no need to create "issue and PR" for each change. Review Comment: ```suggestion For instance, if you fix a typo or make other small fixes, there's no need to create "<em>issue and PR</em>" for each change. ``` ########## xdocs/stylesheets/site_printable.vsl: ########## @@ -239,6 +239,10 @@ No <a href="https://github.com/apache/jmeter/pull/$id.getText()">Pull request #$id.getText()</a>## #end +#macro ( issue $id) Review Comment: If we start adding `<issue>` tags, we should add support for it in `website-style.xsl`, too. ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. + "I also need this" comments cause notifications, and the comment itself does not add much to the discussion. + Instead, prefer adding reactions to the first comment of an existing issue, so the issues could be sorted (see + <a href="https://github.com/apache/jmeter/issues?q=sort%3Areactions-%2B1-desc";>Most voted issues</a>). + </p> + <p> + Please make sure that you describe the enhancement in sufficient detail. It might be a good idea to start with a use-case. + </p> + <p> + There are several options to propose an enhancement request: + <dl> + <dt>GitHub issue</dt> + <dd> + <p> + You could <a href="https://github.com/apache/jmeter/issues/new/choose";>file an issue on GitHub</a> to start a discussion + and gather opinions. GitHub issues allow + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax";>basic formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting";>advanced formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files";>attaching files</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code";>syntax highlight</a>, + <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists";>task lists</a>, + reactions, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests";>references to the other + issues and the source code</a>. + </p> + <p> + When you create an issue at GitHub, it suggests one of the templates (e.g. "Bug report", Review Comment: ```suggestion When you create an issue at GitHub, it suggests one of the templates (e.g. "<em>Bug report</em>", ``` ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. Review Comment: ```suggestion If you find a very similar request in the issues list, please refrain from adding "<em>I also need this</em>" comments to the issue. ``` Not sure, if we need the quotes, when the emphasis is marked up, though. ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. + "I also need this" comments cause notifications, and the comment itself does not add much to the discussion. + Instead, prefer adding reactions to the first comment of an existing issue, so the issues could be sorted (see + <a href="https://github.com/apache/jmeter/issues?q=sort%3Areactions-%2B1-desc";>Most voted issues</a>). + </p> + <p> + Please make sure that you describe the enhancement in sufficient detail. It might be a good idea to start with a use-case. + </p> + <p> + There are several options to propose an enhancement request: + <dl> + <dt>GitHub issue</dt> + <dd> + <p> + You could <a href="https://github.com/apache/jmeter/issues/new/choose";>file an issue on GitHub</a> to start a discussion + and gather opinions. GitHub issues allow + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax";>basic formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting";>advanced formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files";>attaching files</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code";>syntax highlight</a>, + <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists";>task lists</a>, + reactions, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests";>references to the other + issues and the source code</a>. + </p> + <p> + When you create an issue at GitHub, it suggests one of the templates (e.g. "Bug report", + "Feedback about the manual", "Feature Request", "Regression"), and it guides which information is required for each case. Review Comment: ```suggestion "<em>Feedback about the manual</em>", "<em>Feature Request</em>", "<em>Regression</em>"), and it guides which information is required for each case. ``` ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. + "I also need this" comments cause notifications, and the comment itself does not add much to the discussion. Review Comment: ```suggestion "<em>I also need this</em>" comments cause notifications, and the comment itself does not add much to the discussion. ``` same here ########## xdocs/issues.xml: ########## @@ -22,78 +22,116 @@ </properties> <body> <section name="Issue tracker"> -<p> -JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements. -</p> -<p> -Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla. -It's also worth checking first on the JMeter user mailing list; others may already have a solution. -</p> + <p> + JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements. + Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi";>Bugzilla</a>, + and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22. + </p> </section> <section name="Support Questions"> -<p> -Please do not use Bugzilla for asking questions. It is not a support forum. -Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. -The user mailing list has a bigger audience and you are more likely to get an answer quickly. -</p> + <p> + Please do not use GitHub Issues for asking questions. It is not a support forum. + Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there. + The user mailing list has a bigger audience, and you are more likely to get an answer quickly. + </p> </section> <section name="Known Bugs and enhancements"> -<ul> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&product=JMeter&content=";> -Bugzilla - All open bugs and enhancements</a> -</li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Open bugs (excluding enhancements)</a></li> -<li> -<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&cmdtype=doit&order=Bug+Number";> -Bugzilla - Enhancements only</a> -</li> -</ul> + <ul> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc";> + Most voted issues + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen";> + All open bugs and enhancements + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement";> + Open bugs (excluding enhancements) + </a> + </li> + <li> + <a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement";> + Enhancements only + </a> + </li> + </ul> </section> <section name="Requesting an enhancement"> -<p> -In most cases it is worth starting a discussion on the mailing list first. -Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions. -</p> -<p> -If you have not already done so, you need to register an account first, using the "<code>New Account</code>" link at the top of the -main Bugzilla page: <a href="https://bz.apache.org/bugzilla/";>https://bz.apache.org/bugzilla/</a>. -</p> -<p> -Make sure you read and understand the information on the account creation page before signing up. -</p> -<p> -Once logged in, click "<code>File a bug</code>" and select JMeter from the list -Please set the severity to "<code>enhancement</code>". -</p> -<p> -Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case. -</p> -<p> -If you are providing a code patch, also provide a test case, and documentation on how to use the new feature (ideally as a documentation patch). -</p> + <p> + Please check if the same enhancement has already been requested previously. + If you find a very similar request in the issues list, please refrain from adding "I also need this" comments to the issue. + "I also need this" comments cause notifications, and the comment itself does not add much to the discussion. + Instead, prefer adding reactions to the first comment of an existing issue, so the issues could be sorted (see + <a href="https://github.com/apache/jmeter/issues?q=sort%3Areactions-%2B1-desc";>Most voted issues</a>). + </p> + <p> + Please make sure that you describe the enhancement in sufficient detail. It might be a good idea to start with a use-case. + </p> + <p> + There are several options to propose an enhancement request: + <dl> + <dt>GitHub issue</dt> + <dd> + <p> + You could <a href="https://github.com/apache/jmeter/issues/new/choose";>file an issue on GitHub</a> to start a discussion + and gather opinions. GitHub issues allow + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax";>basic formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting";>advanced formatting</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files";>attaching files</a>, + <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code";>syntax highlight</a>, + <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists";>task lists</a>, + reactions, + <a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests";>references to the other + issues and the source code</a>. + </p> + <p> + When you create an issue at GitHub, it suggests one of the templates (e.g. "Bug report", + "Feedback about the manual", "Feature Request", "Regression"), and it guides which information is required for each case. + You could read more on <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue";>creating issues</a> in + GitHub documentation. + </p> + </dd> + <dt>Mailing list discussion</dt> + <dd> + <p> + If you are not sure if something is an enhancement, or if you are unsure regarding the possible solutions, + it might be a good idea to start a discussion on <a href="https://jmeter.apache.org/mail2.html#JMeterDev";>JMeter dev mailing list</a> + </p> + </dd> + <dt>GitHub pull request</dt> + <dd> + <p> + If you are positive regarding the solution, you could start a discussion by creating a + <a href="https://github.com/apache/jmeter/pulls";>pull request on GitHub</a>. + Pull requests are not much different from issues, however, sometimes it is easier to discuss with code at hand. + For instance, if you fix a typo or make other small fixes, there's no need to create "issue and PR" for each change. + The following <a href="https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/";>GitHub post</a> might be helpful + for creating your perfect pull request. + </p> + <p> + Note: there's no guarantee that your contribution will be accepted, so it might be wise to discuss your suggestions Review Comment: We could use the note tag here. ```xml <note>Note: there is no ... </note> ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@jmeter.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
