Skip to content

Commit da6efde

Browse files
committed
Update Bugzilla -> GitHub issues in the contribution documentation
1 parent a3a7edf commit da6efde

File tree

6 files changed

+143
-93
lines changed

6 files changed

+143
-93
lines changed

.editorconfig

+3
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ ij_kotlin_continuation_indent_size = 4
2828
#"static ", "java.", "javax", "org", "net", "com", ""
2929
ij_java_imports_layout = $*,|,java.**,|,javax.**,|,org.**,|,net.**,|,com.**,|,*
3030
ij_java_use_single_class_imports = true
31+
32+
[*.xml]
33+
indent_size = 2

CONTRIBUTING.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ Want to show Apache JMeter some love? Help out by contributing!
44

55
## :beetle: Found a bug
66

7-
Log it in our bugzilla:
7+
Log it in GitHub issues:
8+
9+
* https://github.com/apache/jmeter/issues
10+
* or send a note to the [user mailing list](https://jmeter.apache.org/mail2.html#JMeterUser).
811

9-
* *<https://jmeter.apache.org/issues.html>*
10-
* or send a note to the *user mailing list*.
1112
Be sure to include all relevant information, like the versions of JMeter you’re using as long as Java version.
1213
A Test plan that caused the issue as well as any error messages are also very helpful.
1314

1415
## :question: Need help
1516

16-
Simply contact:
17+
Contact:
1718

1819
* [Our users mailing list](https://jmeter.apache.org/mail2.html#JMeterUser)
1920
* or ask question on [stackoverflow](https://stackoverflow.com/questions/tagged/jmeter).
@@ -22,8 +23,8 @@ Simply contact:
2223

2324
See:
2425

25-
* [Open bug entries for JMeter](https://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&order=Bug%20Number&list_id=164231)
26-
* [Enhancement requests for JMeter](https://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&order=Bug%20Number&list_id=164232)
26+
* [Open issues for JMeter](https://github.com/apache/jmeter/issues)
27+
* [Enhancement requests for JMeter](https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement)
2728

2829
## Development setup
2930

@@ -66,7 +67,7 @@ The best way to make sure your issue or feature is addressed is to submit a patc
6667
We accept patches through:
6768

6869
* pull requests
69-
* patch attached to bugzilla.
70+
* patch attached to [JMeter developers mailing list](https://jmeter.apache.org/mail2.html#JMeterDev).
7071

7172
However, before sending a patch, please make sure that the following applies:
7273

xdocs/building.xml

+13-15
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,20 @@ Check that patch does not break JUnit tests by running:
109109
</p>
110110
<source>./gradlew test</source>
111111

112-
<h3>Create a PR using GIT</h3>
112+
<h3>Create a pull request using Git</h3>
113113
<ul>
114-
<li>Open a bugzilla issue, see <a target="_blank" href="issues.html">Issues page</a></li>
115-
<li>Fork <a href="https://www.github.com/apache/jmeter" >Apache JMeter mirror</a></li>
116-
<li>Clone your forked repository locally : <source>git clone https://github.com/yourid/jmeter/</source></li>
117-
<li>Create a branch using for example bugzilla id: <source>git branch BUGID</source></li>
118-
<li>Checkout the new branch : <source>git checkout BUGID</source></li>
119-
<li>commit your fix there : <source>git commit -m 'Fix to BUGID' list of files</source></li>
114+
<li>Fork <a href="https://www.github.com/apache/jmeter">Apache JMeter mirror</a></li>
115+
<li>Clone your forked repository locally: <source>git clone https://github.com/yourid/jmeter.git</source></li>
116+
<li>Create a branch using for example issue id: <source>git branch gh123-thread-group-typo</source>
117+
(please refrain from using <source>master</source> and <source>main</source> branches for pull request)</li>
118+
<li>Checkout the new branch: <source>git checkout gh123-thread-group-typo</source></li>
119+
<li>Commit your fix there: <source>git commit -m 'Fix to BUGID' list of files</source></li>
120120
<li>Please avoid creating merge commits in the PR. We embrace small changes, and merge commits are harder to review</li>
121-
<li>Add JMeter repository as upstream : <source>git remote add upstream http://www.github.com/apache/jmeter</source></li>
122-
<li>push it : <source>git push origin BUGID</source></li>
123-
<li>Create a PR and link it in the bugzilla issue</li>
124-
<li>Or create a diff and add as attachment to bugzilla issue <source>git diff &gt; BUGID.patch</source></li>
121+
<li>Push it: <source>git push origin gh123-thread-group-typo</source></li>
122+
<li>Create a <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request">pull request</a></li>
125123
</ul>
126124

127-
<note>Different operation systems have different defaults for end-of-line markers.
125+
<note>Different operating systems have different defaults for end-of-line markers.
128126
Typical configuration is CRLF for Windows and LF for macOS and GNU/Linux.<br/>
129127
It is recommended to follow that configuration by appropriate settings of <code>core.autocrlf</code>.
130128
For Windows <source>git config --global core.autocrlf true</source>, and for macOS and GNU/Linux set <source>git config --global core.autocrlf input</source>
@@ -134,17 +132,17 @@ Check that patch does not break JUnit tests by running:
134132
no matter the configuration of the developer workstation.
135133
</note>
136134

137-
<h3>Create a PR using Patch</h3>
135+
<h3>Proposing a change with a patch</h3>
136+
<p>If you cannot to create a pull request at GitHub, you might submit your changes as a unified diff patch on JMeter dev mailing list.</p>
138137
<ul>
139-
<li>Open a bugzilla issue, see <a target="_blank" href="issues.html">Issues page</a></li>
140138
<li>Checkout Apache JMeter source</li>
141139
<li>Code your fix</li>
142140
<li>Create your patch by Right clicking on Eclipse project and select
143141
<menuchoice>
144142
<guimenuitem>Team</guimenuitem>
145143
<guimenuitem>Create Patch &hellip;</guimenuitem>
146144
</menuchoice></li>
147-
<li>Attach your patch to the bugzilla issue</li>
145+
<li>Attach your patch to email message on JMeter dev list</li>
148146
</ul>
149147
</section>
150148

xdocs/issues.xml

+107-70
Original file line numberDiff line numberDiff line change
@@ -22,78 +22,116 @@
2222
</properties>
2323
<body>
2424
<section name="Issue tracker">
25-
<p>
26-
JMeter uses Bugzilla for issue tracking, i.e. for reporting bugs and requesting enhancements.
27-
</p>
28-
<p>
29-
Before creating a new issue, please check whether the issue has already been reported by searching Bugzilla.
30-
It's also worth checking first on the JMeter user mailing list; others may already have a solution.
31-
</p>
25+
<p>
26+
JMeter uses GitHub Issues for issue tracking, i.e. for reporting bugs and requesting enhancements.
27+
Previously, the issues were tracked in <a href="https://bz.apache.org/bugzilla/describecomponents.cgi">Bugzilla</a>,
28+
and all the issues, comments, and attachments have been migrated to GitHub on 2022-09-22.
29+
</p>
3230
</section>
3331
<section name="Support Questions">
34-
<p>
35-
Please do not use Bugzilla for asking questions. It is not a support forum.
36-
Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there.
37-
The user mailing list has a bigger audience and you are more likely to get an answer quickly.
38-
</p>
32+
<p>
33+
Please do not use GitHub Issues for asking questions. It is not a support forum.
34+
Instead, please <a href="mail2.html">subscribe</a> to the JMeter user mailing list and ask there.
35+
The user mailing list has a bigger audience, and you are more likely to get an answer quickly.
36+
</p>
3937
</section>
4038
<section name="Known Bugs and enhancements">
41-
<ul>
42-
<li>
43-
<a href="http://bz.apache.org/bugzilla/buglist.cgi?query_format=specific&amp;order=relevance+desc&amp;bug_status=__open__&amp;product=JMeter&amp;content=">
44-
Bugzilla - All open bugs and enhancements</a>
45-
</li>
46-
<li>
47-
<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_severity=Blocker&amp;bug_severity=Critical&amp;bug_severity=Major&amp;bug_severity=Normal&amp;bug_severity=Regression&amp;bug_severity=Minor&amp;bug_severity=Trivial&amp;product=JMeter&amp;cmdtype=doit&amp;order=Bug+Number">
48-
Bugzilla - Open bugs (excluding enhancements)</a></li>
49-
<li>
50-
<a href="http://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_severity=Enhancement&amp;product=JMeter&amp;cmdtype=doit&amp;order=Bug+Number">
51-
Bugzilla - Enhancements only</a>
52-
</li>
53-
</ul>
39+
<ul>
40+
<li>
41+
<a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+sort%3Areactions-%2B1-desc">
42+
Most voted issues
43+
</a>
44+
</li>
45+
<li>
46+
<a href="https://github.com/apache/jmeter/issues?q=is%3Aopen">
47+
All open bugs and enhancements
48+
</a>
49+
</li>
50+
<li>
51+
<a href="https://github.com/apache/jmeter/issues?q=is%3Aissue+is%3Aopen+-label%3Aenhancement">
52+
Open bugs (excluding enhancements)
53+
</a>
54+
</li>
55+
<li>
56+
<a href="https://github.com/apache/jmeter/issues?q=is%3Aopen+label%3Aenhancement">
57+
Enhancements only
58+
</a>
59+
</li>
60+
</ul>
5461
</section>
5562
<section name="Requesting an enhancement">
56-
<p>
57-
In most cases it is worth starting a discussion on the mailing list first.
58-
Bugzilla is good for tracking progress and supplying patches, but is unwieldy for longer discussions.
59-
</p>
60-
<p>
61-
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
62-
main Bugzilla page: <a href="https://bz.apache.org/bugzilla/">https://bz.apache.org/bugzilla/</a>.
63-
</p>
64-
<p>
65-
Make sure you read and understand the information on the account creation page before signing up.
66-
</p>
67-
<p>
68-
Once logged in, click "<code>File a bug</code>" and select JMeter from the list
69-
Please set the severity to "<code>enhancement</code>".
70-
</p>
71-
<p>
72-
Please make sure that you describe the enhancement in sufficient detail. If necessary provide an example use-case.
73-
</p>
74-
<p>
75-
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).
76-
</p>
63+
<p>
64+
Please check if the same enhancement has already been requested previously.
65+
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.
66+
"<em>I also need this</em>" comments cause notifications, and the comment itself does not add much to the discussion.
67+
Instead, prefer adding reactions to the first comment of an existing issue, so the issues could be sorted (see
68+
<a href="https://github.com/apache/jmeter/issues?q=sort%3Areactions-%2B1-desc">Most voted issues</a>).
69+
</p>
70+
<p>
71+
Please make sure that you describe the enhancement in sufficient detail. It might be a good idea to start with a use-case.
72+
</p>
73+
<p>
74+
There are several options to propose an enhancement request:
75+
<dl>
76+
<dt>GitHub issue</dt>
77+
<dd>
78+
<p>
79+
You could <a href="https://github.com/apache/jmeter/issues/new/choose">file an issue on GitHub</a> to start a discussion
80+
and gather opinions. GitHub issues allow
81+
<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>,
82+
<a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting">advanced formatting</a>,
83+
<a href="https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files">attaching files</a>,
84+
<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>,
85+
<a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists">task lists</a>,
86+
reactions,
87+
<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
88+
issues and the source code</a>.
89+
</p>
90+
<p>
91+
When you create an issue at GitHub, it suggests one of the templates (e.g. "<em>Bug report</em>",
92+
"<em>Feedback about the manual</em>", "<em>Feature Request</em>", "<em>Regression</em>"), and it guides which information is required for each case.
93+
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
94+
GitHub documentation.
95+
</p>
96+
</dd>
97+
<dt>Mailing list discussion</dt>
98+
<dd>
99+
<p>
100+
If you are not sure if something is an enhancement, or if you are unsure regarding the possible solutions,
101+
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>
102+
</p>
103+
</dd>
104+
<dt>GitHub pull request</dt>
105+
<dd>
106+
<p>
107+
If you are positive regarding the solution, you could start a discussion by creating a
108+
<a href="https://github.com/apache/jmeter/pulls">pull request on GitHub</a>.
109+
Pull requests are not much different from issues, however, sometimes it is easier to discuss with code at hand.
110+
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.
111+
The following <a href="https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/">GitHub post</a> might be helpful
112+
for creating your perfect pull request.
113+
</p>
114+
<note>
115+
There's no guarantee that your contribution will be accepted, so it might be wise to discuss your suggestions
116+
before you invest significant efforts on implementing the changes.
117+
</note>
118+
<p>
119+
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).
120+
</p>
121+
</dd>
122+
</dl>
123+
</p>
77124
</section>
78125
<section name="Raising an Issue">
79-
<p>
80-
First check that the issue has not already been reported.
81-
If reporting a bug, are you sure it really is a bug in JMeter, not just a misunderstanding of how JMeter works?
82-
</p>
83-
<p>
84-
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
85-
main Bugzilla page: <a href="https://bz.apache.org/bugzilla/">https://bz.apache.org/bugzilla/</a>.
86-
</p>
87-
<p>
88-
Make sure you read and understand the information on the account creation page before signing up.
89-
</p>
90-
<p>
91-
Once logged in you have 2 options:
92-
<ul>
93-
<li>At the bottom left of the screen click '<code>File a new bug in the "JMeter" product</code>' link</li>
94-
<li>At the top left of the screen, click "<code>New</code>" link and select JMeter from the list.</li>
95-
</ul>
96-
</p>
126+
<p>
127+
First check that the issue has not already been reported on <a href="https://github.com/apache/jmeter/issues">GitHub issues</a>
128+
and <a href="https://lists.apache.org/list.html?user@jmeter.apache.org">JMeter user mailing list</a>).
129+
If reporting a bug, are you sure it really is a bug in JMeter, not just a misunderstanding of how JMeter works?
130+
</p>
131+
<p>
132+
If you face a bug or regression, please create an <a href="https://github.com/apache/jmeter/issues">issue on GitHub</a>.
133+
In case you can't create an issue, you might send the bug report to <a href="https://jmeter.apache.org/mail2.html#JMeterDev">JMeter dev mailing list</a>.
134+
</p>
97135
</section>
98136
<section name="Required Information for bug reporting">
99137
<p>
@@ -112,11 +150,10 @@ Use the checklist below to guide you.
112150
Does it happen every time?
113151
</li>
114152
<li>If you have error messages, that you wish to report, copy them as text into the issue, as it makes it easier to search for them and re-use the message in our research for the origin of the issue</li>
115-
<li>Add yourself in <code>CC</code> List to be notified when JMeter Team requires more information (in this case bug will be marked as <code>NEEDINFO</code>)</li>
116-
<li>When a bug is market as <code>NEEDINFO</code>, please provide as soon as possible the required information so that bug can be understood and fixed. Be aware that if
117-
no information is provided after team requires more information and bug is not reproducible, then bug will be closed as <code>WORKSFORME</code>. You can always reopen it later once you provide the required information.</li>
118-
<li>Select accurately the IMPORTANCE level, <code>ENHANCEMENT</code> means it's not a BUG while others mean it's a BUG</li>
119-
<li>If you are providing a patch to fix a bug, please ensure it is in unified diff format.
153+
<li>When a bug is market as <code>need info</code>, please provide as soon as possible the required information so that bug can be understood and fixed. Be aware that if
154+
no information is provided after team requires more information and bug is not reproducible, then bug will be closed as <code>invalid</code>. You can always ask to reopen it later once you provide the required information.</li>
155+
<li>Prefer using issue templates (e.g. "<em>Bug report</em>", "<em>Feedback about the manual</em>", "<em>Feature Request</em>", "<em>Regression</em>")</li>
156+
<li>If you are providing a patch file to fix a bug, please ensure it is in unified diff format.
120157
If using Eclipse, please set the patch root to "<code>Project</code>", not the default "<code>Workspace</code>" which is harder to apply.</li>
121158
<li>New source files can be provided as is; please ensure they have the standard Apache License header (as per other JMeter files).
122159
Please do not use <code>@author</code> tags (credit will be given in the changes file).
@@ -125,7 +162,7 @@ Please do not use <code>@author</code> tags (credit will be given in the changes
125162
Components are documented in <code>xdocs/usermanual/component_reference.xml</code>.</li>
126163
</ul>
127164
<p><b>See also the following <a href="https://bz.apache.org/bugwritinghelp.html">Bug writing guidelines</a>,
128-
also the terms and conditions noted on the <a href="https://bz.apache.org/bugzilla/createaccount.cgi">Bugzilla account creation page.</a></b></p>
165+
also the terms and conditions noted on the <a href="https://docs.github.com/en/site-policy/github-terms/github-terms-of-service">GitHub Terms of Service</a></b></p>
129166
</section>
130167
</body>
131168
</document>

xdocs/mail2.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Prior to Nov 2011, they were sent to the Jakarta Notifications list, see below.
9797
</subsection>
9898
<subsection name="Apache JMeter Issues" anchor="JMeterIssues">
9999
<p>
100-
<a href="https://bz.apache.org/bugzilla/">Bugzilla</a> messages are sent here.
100+
<a href="https://github.com/apache/jmeter">GitHub</a> notifications are sent here.
101101
</p>
102102
<p>
103103
Prior to Nov 2011, they were sent to the Jakarta Notifications list, see below.

xdocs/stylesheets/site_printable.vsl

+11
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,10 @@ No
239239
<a href="https://github.com/apache/jmeter/pull/$id.getText()">Pull request #$id.getText()</a>##
240240
#end
241241

242+
#macro ( issue $id)
243+
<a href="https://github.com/apache/jmeter/issues/$id.getText()">Issue #$id.getText()</a>##
244+
#end
245+
242246
#macro ( rfc $id)
243247
#if($id.getText())
244248
<a href="https://tools.ietf.org/html/rfc$id.getAttributeValue('link')">$id.getText()</a>##
@@ -257,6 +261,11 @@ No
257261
#pullrequest($id) - ##
258262
#end
259263

264+
## Shorthand - automatically adds " - " before remaining text
265+
#macro ( issue_dash $id)
266+
#issue($id) - ##
267+
#end
268+
260269
#macro ( contributor $id)
261270
Contributed by $id.getAttributeValue("name") &lt;$id.getAttributeValue("mail")&gt;
262271
#end
@@ -317,6 +326,8 @@ Contributed by $id.getAttributeValue("name") &lt;$id.getAttributeValue("mail")&g
317326
#bug ($node)
318327
#elseif ($node.getName().equals("pr"))
319328
#pr ($node)
329+
#elseif ($node.getName().equals("issue"))
330+
#issue ($node)
320331
#elseif ($node.getName().equals("rfc"))
321332
#rfc ($node)
322333
#elseif ($node.getName().equals("contributor"))

0 commit comments

Comments
 (0)